Interface ImportFolderService

All Known Implementing Classes:
SoapImportFolderClient, SoapImportFolderService

public interface ImportFolderService
WebService administration of import folders
Since:
6.1
Author:
Marco Meschieri - LogicalDOC
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(String sid, long folderId)
    Deletes an imported folder with the given identifier
    list(String sid)
    Gets folder metadata of all imported folders
    long
    store(String sid, WSImportFolder folder)
    Create/Update an imported folder.
  • Method Details

    • list

      List<WSImportFolder> list(String sid) throws FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Gets folder metadata of all imported folders
      Parameters:
      sid - Session identifier
      Returns:
      A value object containing the folders metadata
      Throws:
      FeatureNotEnabledException - Feature not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
    • store

      long store(String sid, WSImportFolder folder) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Create/Update an imported folder. You can completely customize the imported folder through a value object containing the folder's metadata
      Parameters:
      sid - Session identifier
      folder - Web service value object containing the folder's metadata
      Returns:
      id of the created/updated import folder
      Throws:
      FeatureNotEnabledException - Feature not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
    • delete

      void delete(String sid, long folderId) throws com.logicaldoc.core.PersistenceException, com.logicaldoc.webservice.WebserviceException
      Deletes an imported folder with the given identifier
      Parameters:
      sid - Session identifier
      folderId - The folder id
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice