Package com.logicaldoc.enterprise.webservice.soap.endpoint

Class SoapArchiveService

java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.enterprise.webservice.soap.endpoint.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 Summary

    Constructors
    Constructor
    Description
    SoapArchiveService()
     

  • 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

    Methods inherited from class com.logicaldoc.webservice.AbstractService

    convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SoapArchiveService

      public SoapArchiveService()

  • Method Details

    • listArchivedDocs

      public com.logicaldoc.webservice.model.WSDocument[] listArchivedDocs(String sid, long folderId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      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:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - Feature not enabled in the license

    • archiveFolder

      public long archiveFolder(String sid, long folderId, String comment) throws com.logicaldoc.webservice.WebserviceException, FeatureNotEnabledException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.PersistenceException, com.logicaldoc.core.security.authorization.PermissionException
      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:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      FeatureNotEnabledException - Feature not enabled in the license
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions

    • archiveDocuments

      public void archiveDocuments(String sid, long[] docIds, String comment) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      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:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - Feature not enabled in the license

    • unarchiveDocuments

      public void unarchiveDocuments(String sid, long[] docIds) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException
      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:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      FeatureNotEnabledException - Feature not enabled in the license