Interface ConversionService
-
- All Known Implementing Classes:
RestConversionService
,SoapConversionClient
,SoapConversionService
public interface ConversionService
Conversion Web Service definition interface- Since:
- 7.7.3
- Author:
- Marco Meschieri - LogicalDOC
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.activation.DataHandler
convertDocument(String sid, long docId, String fileVersion, String format)
Converts an existing document and saves the generated conversion in LogicalDOC.long
convertDocumentAndSave(String sid, long docId, String fileVersion, String format)
Converts an existing document and saves the generated conversion in LogicalDOC.void
convertDocumentToPdf(String sid, long docId, String fileVersion)
Creates the PDF conversion of the given document.javax.activation.DataHandler
convertFile(String sid, String fileName, String format, javax.activation.DataHandler fileContent)
Converts a given file and returns the conversion.
-
-
-
Method Detail
-
convertDocument
javax.activation.DataHandler convertDocument(String sid, long docId, String fileVersion, String format) throws Exception
Converts an existing document and saves the generated conversion in LogicalDOC.- Parameters:
sid
- Session identifierdocId
- The document idfileVersion
- The file versionformat
- The output conversion format- Returns:
- The conversion's binary
- Throws:
Exception
- error in the service
-
convertDocumentAndSave
long convertDocumentAndSave(String sid, long docId, String fileVersion, String format) throws Exception
Converts an existing document and saves the generated conversion in LogicalDOC.- Parameters:
sid
- Session identifierdocId
- The document idfileVersion
- The file versionformat
- The output conversion format- Returns:
- the ID of the generated conversion file
- Throws:
Exception
- error in the service
-
convertDocumentToPdf
void convertDocumentToPdf(String sid, long docId, String fileVersion) throws Exception
Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.- Parameters:
sid
- Session identifierdocId
- The document idfileVersion
- The specific file version(it can be empty)- Throws:
Exception
- error in the service
-
convertFile
javax.activation.DataHandler convertFile(String sid, String fileName, String format, javax.activation.DataHandler fileContent) throws Exception
Converts a given file and returns the conversion.- Parameters:
sid
- Session identifierfileName
- Name of the source fileformat
- The output conversion formatfileContent
- The content of the input file- Returns:
- the raw content of the converted file
- Throws:
Exception
- error in the service
-
-