Interface ImpexService
-
- All Known Implementing Classes:
SoapImpexClient
,SoapImpexService
public interface ImpexService
Handles impex archives- Since:
- 7.1.2
- Author:
- Marco Meschieri - LogicalDOC
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
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 archiveLong
getArchiveIdByName(String sid, String name)
Retrieves the ID of an existing archive
-
-
-
Method Detail
-
createExportArchive
long createExportArchive(String sid, String name, String description) throws Exception
Defines a new export archive.- Parameters:
sid
- Session identifiername
- Name of the archive, mandatorydescription
- Description of the archive, optional- Returns:
- The id of the newly created export archive
- Throws:
Exception
- error in the server
-
addDocumentToExportArchive
void addDocumentToExportArchive(String sid, long archiveId, long docId) throws Exception
Adds a document to an existing export archive- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be useddocId
- identifier of the document to be added- Throws:
Exception
- error in the server
-
closeExportArchive
void closeExportArchive(String sid, long archiveId) throws Exception
Closes an export archive- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be closed- Throws:
Exception
- error in the server
-
deleteExportArchive
void deleteExportArchive(String sid, long archiveId) throws Exception
Deletes an export archive- Parameters:
sid
- Session identifierarchiveId
- identifier of the archive to be closed- Throws:
Exception
- error in the server
-
-