Class SoapImpexClient
java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<ImpexService>
com.logicaldoc.impex.webservice.soap.client.SoapImpexClient
- All Implemented Interfaces:
ImpexService
public class SoapImpexClient
extends com.logicaldoc.webservice.soap.client.SoapClient<ImpexService>
implements ImpexService
-
Constructor Summary
ConstructorDescriptionSoapImpexClient
(String endpoint) SoapImpexClient
(String endpoint, int gzipThreshold, boolean log, int timeout) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDocumentToExportArchive
(String sid, long archiveId, long docId) Adds a document to an existing export archivevoid
closeExportArchive
(String sid, long archiveId) Closes an export archivelong
createExportArchive
(String sid, String name, String description) Defines a new export archive.void
deleteExportArchive
(String sid, long archiveId) Deletes an export archivegetArchiveIdByName
(String sid, String name) Retrieves the ID of an existing archive
-
Constructor Details
-
SoapImpexClient
-
SoapImpexClient
-
-
Method Details
-
createExportArchive
public long createExportArchive(String sid, String name, String description) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:ImpexService
Defines a new export archive.- Specified by:
createExportArchive
in interfaceImpexService
- Parameters:
sid
- Session identifiername
- Name of the archive, mandatorydescription
- Description of the archive, optional- Returns:
- The id of the newly created export archive
- Throws:
com.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layer
-
addDocumentToExportArchive
public void addDocumentToExportArchive(String sid, long archiveId, long docId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, com.logicaldoc.gui.common.client.ServerException Description copied from interface:ImpexService
Adds a document to an existing export archive- Specified by:
addDocumentToExportArchive
in interfaceImpexService
- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be useddocId
- identifier of the document to be added- Throws:
com.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.gui.common.client.ServerException
- Error in the application server
-
closeExportArchive
public void closeExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:ImpexService
Closes an export archive- Specified by:
closeExportArchive
in interfaceImpexService
- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be closed- Throws:
com.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layer
-
deleteExportArchive
public void deleteExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:ImpexService
Deletes an export archive- Specified by:
deleteExportArchive
in interfaceImpexService
- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be closed- Throws:
com.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layer
-
getArchiveIdByName
public Long getArchiveIdByName(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:ImpexService
Retrieves the ID of an existing archive- Specified by:
getArchiveIdByName
in interfaceImpexService
- Parameters:
sid
- Session identifiername
- Name of the archive- Returns:
- The id of the archive
- Throws:
com.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layer
-