Class SoapArchiveClient
- java.lang.Object
-
- com.logicaldoc.webservice.soap.client.SoapClient<ArchiveService>
-
- com.logicaldoc.enterprise.webservice.soap.client.SoapArchiveClient
-
- All Implemented Interfaces:
ArchiveService
public class SoapArchiveClient extends com.logicaldoc.webservice.soap.client.SoapClient<ArchiveService> implements ArchiveService
Archive Web Service client.- Since:
- 7.2
- Author:
- Marco Meschieri - LogicalDOC
-
-
Constructor Summary
Constructors Constructor Description SoapArchiveClient(String endpoint)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
archiveDocuments(String sid, long[] docIds, String comment)
Archives a set of documentslong
archiveFolder(String sid, long folderId, String comment)
Archives all the documents contained in a treecom.logicaldoc.webservice.model.WSDocument[]
listArchivedDocs(String sid, long folderId)
Lists the archived documentsvoid
unarchiveDocuments(String sid, long[] docIds)
Restores a set of archived documents
-
-
-
Constructor Detail
-
SoapArchiveClient
public SoapArchiveClient(String endpoint) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listArchivedDocs
public com.logicaldoc.webservice.model.WSDocument[] listArchivedDocs(String sid, long folderId) throws Exception
Description copied from interface:ArchiveService
Lists the archived documents- Specified by:
listArchivedDocs
in interfaceArchiveService
- Parameters:
sid
- Session identifierfolderId
- If specified, it searches for all the archived documents inside this folder- Returns:
- The list of archived documents
- Throws:
Exception
- error in the server
-
archiveFolder
public long archiveFolder(String sid, long folderId, String comment) throws Exception
Description copied from interface:ArchiveService
Archives all the documents contained in a tree- Specified by:
archiveFolder
in interfaceArchiveService
- Parameters:
sid
- Session identifierfolderId
- All the documents stored inside this folder at whatever depth will be archivedcomment
- reason of this action- Returns:
- Number of archived documents
- Throws:
Exception
- error in the server
-
archiveDocuments
public void archiveDocuments(String sid, long[] docIds, String comment) throws Exception
Description copied from interface:ArchiveService
Archives a set of documents- Specified by:
archiveDocuments
in interfaceArchiveService
- Parameters:
sid
- Session identifierdocIds
- All the documents to be archivedcomment
- reason of this action- Throws:
Exception
- error in the server
-
unarchiveDocuments
public void unarchiveDocuments(String sid, long[] docIds) throws Exception
Description copied from interface:ArchiveService
Restores a set of archived documents- Specified by:
unarchiveDocuments
in interfaceArchiveService
- Parameters:
sid
- Session identifierdocIds
- All the documents to be restored- Throws:
Exception
- error in the server
-
-