Class SoapImpexService
java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.impex.webservice.soap.endpoint.SoapImpexService
- All Implemented Interfaces:
ImpexService
public class SoapImpexService
extends com.logicaldoc.webservice.AbstractService
implements ImpexService
Document Metadata Web Service Implementation
- Since:
- 6.1
- Author:
- Matteo Caruso - LogicalDOC
-
Constructor Summary
-
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 archiveMethods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession
-
Constructor Details
-
SoapImpexService
public SoapImpexService()
-
-
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 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 layer
-
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
-