Interface SplitService
- All Known Implementing Classes:
SoapSplitClient
,SoapSplitService
public interface SplitService
WebService to allow a user to split documents
- Since:
- 8.4
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionsplitAllPages
(String sid, long docId) Splits a PDF document, each page in a different filesplitSelection
(String sid, long docId, String expression) Splits a PDF document in a selection of pagessplitUsingBarcode
(String sid, long docId, String expression, int separator) Splits a PDF document using a barcode as separatorsplitUsingBlankPage
(String sid, long docId, int separator) Splits a PDF document using a blank page as separatorsplitUsingText
(String sid, long docId, String expression, int separator) Splits a PDF document using a text as separator
-
Method Details
-
splitAllPages
List<Long> splitAllPages(String sid, long docId) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Splits a PDF document, each page in a different file- Parameters:
sid
- identifier of the sessiondocId
- identifier of the document- Returns:
- identifiers of the created segments
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
splitSelection
List<Long> splitSelection(String sid, long docId, String expression) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Splits a PDF document in a selection of pages- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- the selection of pages (e.g.: 1,2,4-6,9)- Returns:
- identifiers of the created segments
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
splitUsingBlankPage
List<Long> splitUsingBlankPage(String sid, long docId, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Splits a PDF document using a blank page as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentseparator
- how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment- Returns:
- identifiers of the created segments
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
splitUsingBarcode
List<Long> splitUsingBarcode(String sid, long docId, String expression, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Splits a PDF document using a barcode as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- regular expression that must be matched by the barcode's value, seePattern
separator
- how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment- Returns:
- identifiers of the created segments
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
splitUsingText
List<Long> splitUsingText(String sid, long docId, String expression, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Splits a PDF document using a text as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- regular expression that must be matched by the text, seePattern
separator
- how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment- Returns:
- identifiers of the created segments
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-