Package com.lexmark.saperion.client.implementation.document

Class DocumentElementClientImpl

java.lang.Object
com.lexmark.saperion.client.implementation.document.DocumentElementClientImpl
All Implemented Interfaces:
DocumentElementClient
public class DocumentElementClientImpl extends Object implements DocumentElementClient
This is the default implementation of DocumentElementClient.
Author:
jschwarz

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentElementClientImpl(com.lexmark.saperion.document.DocumentService documentService, com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, com.lexmark.saperion.document.DocumentElementReferenceType reference)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.lexmark.saperion.document.DocumentElementStoreInformationType
    appendChild(com.lexmark.saperion.document.DocumentElementType element)
    This method appends a given document element as a child to the current one.
    void
    delete()
    This method deletes the current document element.
    InputStream
    loadContent()
    This method Opens the content of the document element identified by the given id for reading and returns an input stream for that data.
    InputStream
    renderContent(com.lexmark.saperion.document.RenditionType renditionType, com.lexmark.saperion.document.RenderOption... renderOptions)
    This method render the content of the given element into given type with given options and return as InputStream
    com.lexmark.saperion.document.DocumentElementStoreInformationType
    update(com.lexmark.saperion.document.DocumentElementType element)
    This method updates the document element instance and replaces it with the given entity.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.lexmark.saperion.client.document.DocumentElementClient

    renderContent

  • Constructor Details

    • DocumentElementClientImpl

      public DocumentElementClientImpl(com.lexmark.saperion.document.DocumentService documentService, com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, com.lexmark.saperion.document.DocumentElementReferenceType reference)

  • Method Details

    • update

      public com.lexmark.saperion.document.DocumentElementStoreInformationType update(com.lexmark.saperion.document.DocumentElementType element) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: DocumentElementClient
      This method updates the document element instance and replaces it with the given entity.
      Specified by:
      update in interface DocumentElementClient
      Parameters:
      element - the update document element input
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • appendChild

      public com.lexmark.saperion.document.DocumentElementStoreInformationType appendChild(com.lexmark.saperion.document.DocumentElementType element) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: DocumentElementClient
      This method appends a given document element as a child to the current one. This method is only valid for structure composite document elements.
      Specified by:
      appendChild in interface DocumentElementClient
      Parameters:
      element - the element to append
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • loadContent

      public InputStream loadContent() throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: DocumentElementClient
      This method Opens the content of the document element identified by the given id for reading and returns an input stream for that data. If the element is chunked the resulting stream will stream over all the chunks.
      Specified by:
      loadContent in interface DocumentElementClient
      Returns:
      an input stream for the content of the given document element
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • renderContent

      public InputStream renderContent(com.lexmark.saperion.document.RenditionType renditionType, com.lexmark.saperion.document.RenderOption... renderOptions) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: DocumentElementClient
      This method render the content of the given element into given type with given options and return as InputStream
      Specified by:
      renderContent in interface DocumentElementClient
      Returns:
      An instance of InputStream
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • delete

      public void delete() throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: DocumentElementClient
      This method deletes the current document element.
      Specified by:
      delete in interface DocumentElementClient
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred