Class SoapImpexService

java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.impex.webservice.soap.endpoint.SoapImpexService
All Implemented Interfaces:
ImpexService

public class SoapImpexService extends com.logicaldoc.webservice.AbstractService implements ImpexService
Document Metadata Web Service Implementation
Since:
6.1
Author:
Matteo Caruso - LogicalDOC
  • Constructor Details

    • SoapImpexService

      public SoapImpexService()
  • Method Details

    • createExportArchive

      public long createExportArchive(String sid, String name, String description) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Defines a new export archive.
      Specified by:
      createExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      name - Name of the archive, mandatory
      description - Description of the archive, optional
      Returns:
      The id of the newly created export archive
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • addDocumentToExportArchive

      public void addDocumentToExportArchive(String sid, long archiveId, long docId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Adds a document to an existing export archive
      Specified by:
      addDocumentToExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be used
      docId - identifier of the document to be added
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • closeExportArchive

      public void closeExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Closes an export archive
      Specified by:
      closeExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be closed
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • deleteExportArchive

      public void deleteExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Deletes an export archive
      Specified by:
      deleteExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be closed
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • getArchiveIdByName

      public Long getArchiveIdByName(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Retrieves the ID of an existing archive
      Specified by:
      getArchiveIdByName in interface ImpexService
      Parameters:
      sid - Session identifier
      name - Name of the archive
      Returns:
      The id of the archive
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer