Package com.lexmark.saperion.client

Interface SaperionClient

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
SaperionClientImpl
public interface SaperionClient extends AutoCloseable
The saperion client provides a client interface for the saperion functionality. It serves as an entry point to create clients for different functionalities.
Author:
jschwarz

  • Method Details

    • getWorkflowService

      WorkflowServiceClient getWorkflowService()
      This method returns a client offering workflow functionality.
      Returns:
      a workflow service client instance

    • getDocumentService

      DocumentServiceClient getDocumentService()
      This method returns a client offering document operations.
      Returns:
      a document service client instance

    • getFolderService

      FolderServiceClient getFolderService()
      This method returns a client offering folder operations.
      Returns:
      a folder service client instance

    • getRecordService

      RecordServiceClient getRecordService()
      This method returns the client offering record operations.
      Returns:
      a record service client instance

    • getArchiveService

      ArchiveServiceClient getArchiveService()
      This method returns a client to search for specific archives.
      Returns:
      an archive search client instance

    • getUserAdministrationService

      UserAdministrationClient getUserAdministrationService()
      This method returns a client offering tenant, user and group management functionality.
      Returns:
      a user management service client instance

    • getLookupEntryService

      LookupEntryServiceClient getLookupEntryService()
      This method returns a client offering lookup entry functionality.
      Returns:
      a lookup entry service client instance

    • getServiceInformationClient

      ServiceInformationClient getServiceInformationClient()
      This method returns a client that provides information about the service itself.
      Returns:
      a client that returns information about the service

    • close

      void close() throws com.lexmark.saperion.exceptions.EcmException
      This method closes the client. It logs out the user and removes the underlying session. The result of calls to any other method after close has been called is undefined.
      Specified by:
      close in interface AutoCloseable
      Throws:
      com.lexmark.saperion.exceptions.EcmException