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 Details

    • listArchivedDocs

      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
      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:
      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
    • archiveFolder

      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
      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:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      FeatureNotEnabledException - Feature not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
    • archiveDocuments

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

      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
      Restores a set of archived documents
      Parameters:
      sid - Session identifier
      docIds - All the documents to be restored
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      FeatureNotEnabledException - Feature not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions