Package com.lexmark.saperion.client.document

Interface DocumentClient

  • All Known Implementing Classes:
    DocumentClientImpl
    public interface DocumentClient
    This client provides functionality concerning a given document.
    Author:
    jschwarz

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
      This method loads the ACLs set on the current revision of the specified document.
      DocumentRevisionClient getRevision​(com.lexmark.saperion.document.DocumentRevisionReferenceType id)
      This method returns a document revision client bound to the given revision of the given document.
      java.util.List<com.lexmark.saperion.document.DocumentRevisionType> getRevisionHistory()
      This method returns the revision history of a given document.
      DocumentRevisionClient latestRevision()
      This method returns a document revision client bound to the newest revision of the given document.
      void lock()
      This method locks the document.
      void unlock()
      This method unlocks the document.

    • Method Detail

      • latestRevision

        DocumentRevisionClient latestRevision()
                               throws com.lexmark.saperion.exceptions.EcmException
        This method returns a document revision client bound to the newest revision of the given document. Note that using it may result in write-read, read-write and write-write conflicts.
        Returns:
        a document revision client bound to the newest revision of the given document
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • getRevision

        DocumentRevisionClient getRevision​(com.lexmark.saperion.document.DocumentRevisionReferenceType id)
        This method returns a document revision client bound to the given revision of the given document.
        Parameters:
        id - the document revision id
        Returns:
        the document revision client for the given document id

      • lock

        void lock()
   throws com.lexmark.saperion.exceptions.EcmException
        This method locks the document.
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when locking the document failed

      • unlock

        void unlock()
     throws com.lexmark.saperion.exceptions.EcmException
        This method unlocks the document.
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when unlocking the document failed

      • getACLs

        java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method loads the ACLs set on the current revision of the specified document.
        Returns:
        the ACLs currently set
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed

      • getRevisionHistory

        java.util.List<com.lexmark.saperion.document.DocumentRevisionType> getRevisionHistory()
                                                                               throws com.lexmark.saperion.exceptions.EcmException
        This method returns the revision history of a given document.
        Returns:
        a list of revision metadata for all the previous revisions
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when loading revision metadata failed