Package com.logicaldoc.enterprise.webservice.soap

Interface ArchiveService

All Known Implementing Classes:

SoapArchiveClient, SoapArchiveService

public interface ArchiveService

Method Summary

Modifier and Type	Method	Description
void	archiveDocuments(String sid, long[] docIds, String comment)	Archives a set of documents
long	archiveFolder(String sid, long folderId, String comment)	Archives all the documents contained in a tree
com.logicaldoc.webservice.model.WSDocument[]	listArchivedDocs(String sid, long folderId)	Lists the archived documents
void	unarchiveDocuments(String sid, long[] docIds)	Restores a set of archived documents

Method Detail

listArchivedDocs

com.logicaldoc.webservice.model.WSDocument[] listArchivedDocs(String sid,
                                                              long folderId)
                                                       throws Exception

Lists the archived documents

Parameters:

sid - Session identifier

folderId - 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

long archiveFolder(String sid,
                   long folderId,
                   String comment)
            throws Exception

Archives all the documents contained in a tree

Parameters:

sid - Session identifier

folderId - All the documents stored inside this folder at whatever depth will be archived

comment - reason of this action

Returns:

Number of archived documents

Throws:

Exception - error in the server

archiveDocuments

void archiveDocuments(String sid,
                      long[] docIds,
                      String comment)
               throws Exception

Archives a set of documents

Parameters:

sid - Session identifier

docIds - All the documents to be archived

comment - reason of this action

Throws:

Exception - error in the server

unarchiveDocuments

void unarchiveDocuments(String sid,
                        long[] docIds)
                 throws Exception

Restores a set of archived documents

Parameters:

sid - Session identifier

docIds - All the documents to be restored

Throws:

Exception - error in the server