Package com.lexmark.saperion.client.document

Interface DocumentServiceClient

  • All Known Implementing Classes:
    DocumentServiceClientImpl
    public interface DocumentServiceClient
    This client provides functionality concerning documents.
    Author:
    jschwarz

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index, com.lexmark.saperion.document.DocumentElementType structure)
      This method creates a new document with the given properties in the given archive.
      com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.document.CreateDocumentInputType properties)
      This method creates a new document with the given properties in the given archive.
      DocumentClient resolve​(com.lexmark.saperion.document.DocumentReferenceType reference)
      This method returns a client for the document referenced.
      DocumentRevisionClient resolve​(com.lexmark.saperion.document.DocumentRevisionReferenceType reference)
      This method returns a client for the document revision referenced.

    • Method Detail

      • resolve

        DocumentClient resolve​(com.lexmark.saperion.document.DocumentReferenceType reference)
        This method returns a client for the document referenced.
        Parameters:
        reference - a reference to the document
        Returns:
        a client for the document referenced

      • resolve

        DocumentRevisionClient resolve​(com.lexmark.saperion.document.DocumentRevisionReferenceType reference)
        This method returns a client for the document revision referenced.
        Parameters:
        reference - a reference to the document revision
        Returns:
        a client for the document revision referenced

      • createDocument

        com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                          java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index,
                                                                          com.lexmark.saperion.document.DocumentElementType structure)
                                                                   throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new document with the given properties in the given archive.
        Parameters:
        archiveReference - a reference to the archive to create the document in
        index - the index properties of the document as defined by the archive
        structure - the documents content structure
        Returns:
        a reference to the newly created document
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • createDocument

        com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.document.CreateDocumentInputType properties)
                                                                   throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new document with the given properties in the given archive.
        Parameters:
        properties - the properties of the new document containing the archive, structure, metadata and ACLs
        Returns:
        a reference to the newly created document
        Throws:
        com.lexmark.saperion.exceptions.EcmException