Class SoapArchiveService

  • All Implemented Interfaces:
    ArchiveService

    public class SoapArchiveService
    extends com.logicaldoc.webservice.AbstractService
    implements ArchiveService
    Archive Web Service Implementation
    Since:
    7.2
    Author:
    Marco Meschieri - LogicalDOC
    • Constructor Detail

      • SoapArchiveService

        public SoapArchiveService()
    • 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 interface ArchiveService
        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

        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 interface ArchiveService
        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

        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 interface ArchiveService
        Parameters:
        sid - Session identifier
        docIds - All the documents to be archived
        comment - 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 interface ArchiveService
        Parameters:
        sid - Session identifier
        docIds - All the documents to be restored
        Throws:
        Exception - error in the server