Class AbstractDocumentDelegateService

  • All Implemented Interfaces:
    com.lexmark.saperion.document.DocumentService
    Direct Known Subclasses:
    DocumentDelegateService

    public abstract class AbstractDocumentDelegateService
    extends AbstractDelegateService<com.lexmark.saperion.document.DocumentService>
    implements com.lexmark.saperion.document.DocumentService
    This DocumentService simply delegates to another instance.
    Author:
    jschwarz
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.lexmark.saperion.document.DocumentElementStoreInformationType appendChildElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, com.lexmark.saperion.document.DocumentElementReferenceType elementReference, com.lexmark.saperion.document.DocumentElementType child)  
      com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(boolean verify, com.lexmark.saperion.document.CreateDocumentInputType properties)  
      com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> indexData, com.lexmark.saperion.document.DocumentElementType rootElement)  
      com.lexmark.saperion.document.DocumentRevisionType deleteDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReferenceType)  
      com.lexmark.saperion.document.DocumentStoreInformationType deleteDocumentElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, com.lexmark.saperion.document.DocumentElementReferenceType elementReference)  
      java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs​(com.lexmark.saperion.document.DocumentReferenceType documentReference)  
      com.lexmark.saperion.document.DocumentRevisionReferenceType getLatestRevisionId​(com.lexmark.saperion.document.DocumentReferenceType documentId)  
      java.util.List<com.lexmark.saperion.document.DocumentRevisionType> getRevisionHistory​(com.lexmark.saperion.document.DocumentReferenceType documentReference)  
      com.lexmark.saperion.document.DocumentRevisionType loadDocument​(com.lexmark.saperion.document.DocumentReferenceType documentId, com.lexmark.saperion.document.LoadKindEnumeration loadKind)  
      com.lexmark.saperion.document.DocumentRevisionType loadDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionId, com.lexmark.saperion.document.LoadKindEnumeration loadKind)  
      void lockDocument​(com.lexmark.saperion.document.DocumentReferenceType documentReference)  
      com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.PropertyType> newMultiValueFieldSearchService​(com.lexmark.saperion.document.DocumentRevisionReferenceType document, java.lang.String fieldName)  
      void purgeDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType document)  
      java.io.InputStream readDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId)  
      java.io.InputStream renderDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId, com.lexmark.saperion.document.RenditionType renditionType)  
      java.io.InputStream renderDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId, com.lexmark.saperion.document.RenditionType renditionType, com.lexmark.saperion.document.RenderOption... renderOptions)  
      com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.document.DocumentRevisionListItemType> searchServiceForDefinition​(com.lexmark.saperion.archive.ArchiveReferenceType definitionReference, java.lang.Boolean recycleBinAware, java.lang.Boolean revisionAware)  
      void unlockDocument​(com.lexmark.saperion.document.DocumentReferenceType documentReference)  
      com.lexmark.saperion.document.DocumentStoreInformationType updateDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType reference, boolean verify, com.lexmark.saperion.document.UpdateDocumentInputType properties)  
      com.lexmark.saperion.document.DocumentElementStoreInformationType updateDocumentElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, com.lexmark.saperion.document.DocumentElementReferenceType elementReference, boolean verify, com.lexmark.saperion.document.DocumentElementType element)  
      void writeFulltextData​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference, java.lang.String fieldName, java.io.InputStream data)  
      • 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.document.DocumentService

        updateDocument
    • Constructor Detail

      • AbstractDocumentDelegateService

        public AbstractDocumentDelegateService()
    • Method Detail

      • getLatestRevisionId

        public com.lexmark.saperion.document.DocumentRevisionReferenceType getLatestRevisionId​(com.lexmark.saperion.document.DocumentReferenceType documentId)
                                                                                        throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        getLatestRevisionId in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • loadDocument

        public com.lexmark.saperion.document.DocumentRevisionType loadDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionId,
                                                                               com.lexmark.saperion.document.LoadKindEnumeration loadKind)
                                                                        throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        loadDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • loadDocument

        public com.lexmark.saperion.document.DocumentRevisionType loadDocument​(com.lexmark.saperion.document.DocumentReferenceType documentId,
                                                                               com.lexmark.saperion.document.LoadKindEnumeration loadKind)
                                                                        throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        loadDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • readDocumentElementContent

        public java.io.InputStream readDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId,
                                                              com.lexmark.saperion.document.DocumentElementReferenceType documentElementId)
                                                       throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        readDocumentElementContent in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • renderDocumentElementContent

        public java.io.InputStream renderDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId,
                                                                com.lexmark.saperion.document.DocumentElementReferenceType documentElementId,
                                                                com.lexmark.saperion.document.RenditionType renditionType,
                                                                com.lexmark.saperion.document.RenderOption... renderOptions)
                                                         throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        renderDocumentElementContent in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • renderDocumentElementContent

        public java.io.InputStream renderDocumentElementContent​(com.lexmark.saperion.document.DocumentRevisionReferenceType documentId,
                                                                com.lexmark.saperion.document.DocumentElementReferenceType documentElementId,
                                                                com.lexmark.saperion.document.RenditionType renditionType)
                                                         throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        renderDocumentElementContent in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • createDocument

        public com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                                         java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> indexData,
                                                                                         com.lexmark.saperion.document.DocumentElementType rootElement)
                                                                                  throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        createDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • createDocument

        public com.lexmark.saperion.document.DocumentStoreInformationType createDocument​(boolean verify,
                                                                                         com.lexmark.saperion.document.CreateDocumentInputType properties)
                                                                                  throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        createDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • updateDocument

        public com.lexmark.saperion.document.DocumentStoreInformationType updateDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType reference,
                                                                                         boolean verify,
                                                                                         com.lexmark.saperion.document.UpdateDocumentInputType properties)
                                                                                  throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        updateDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • appendChildElement

        public com.lexmark.saperion.document.DocumentElementStoreInformationType appendChildElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference,
                                                                                                    com.lexmark.saperion.document.DocumentElementReferenceType elementReference,
                                                                                                    com.lexmark.saperion.document.DocumentElementType child)
                                                                                             throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        appendChildElement in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • updateDocumentElement

        public com.lexmark.saperion.document.DocumentElementStoreInformationType updateDocumentElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference,
                                                                                                       com.lexmark.saperion.document.DocumentElementReferenceType elementReference,
                                                                                                       boolean verify,
                                                                                                       com.lexmark.saperion.document.DocumentElementType element)
                                                                                                throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        updateDocumentElement in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • deleteDocumentElement

        public com.lexmark.saperion.document.DocumentStoreInformationType deleteDocumentElement​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference,
                                                                                                com.lexmark.saperion.document.DocumentElementReferenceType elementReference)
                                                                                         throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        deleteDocumentElement in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • searchServiceForDefinition

        public com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.document.DocumentRevisionListItemType> searchServiceForDefinition​(com.lexmark.saperion.archive.ArchiveReferenceType definitionReference,
                                                                                                                                                         java.lang.Boolean recycleBinAware,
                                                                                                                                                         java.lang.Boolean revisionAware)
                                                                                                                                                  throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        searchServiceForDefinition in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • deleteDocument

        public com.lexmark.saperion.document.DocumentRevisionType deleteDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReferenceType)
                                                                          throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        deleteDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • newMultiValueFieldSearchService

        public com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.PropertyType> newMultiValueFieldSearchService​(com.lexmark.saperion.document.DocumentRevisionReferenceType document,
                                                                                                                                     java.lang.String fieldName)
                                                                                                                              throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        newMultiValueFieldSearchService in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • lockDocument

        public void lockDocument​(com.lexmark.saperion.document.DocumentReferenceType documentReference)
                          throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        lockDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • unlockDocument

        public void unlockDocument​(com.lexmark.saperion.document.DocumentReferenceType documentReference)
                            throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        unlockDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • getACLs

        public java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs​(com.lexmark.saperion.document.DocumentReferenceType documentReference)
                                                                                     throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        getACLs in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • getRevisionHistory

        public java.util.List<com.lexmark.saperion.document.DocumentRevisionType> getRevisionHistory​(com.lexmark.saperion.document.DocumentReferenceType documentReference)
                                                                                              throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        getRevisionHistory in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • purgeDocument

        public void purgeDocument​(com.lexmark.saperion.document.DocumentRevisionReferenceType document)
                           throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        purgeDocument in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • writeFulltextData

        public void writeFulltextData​(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionReference,
                                      java.lang.String fieldName,
                                      java.io.InputStream data)
                               throws com.lexmark.saperion.exceptions.EcmException
        Specified by:
        writeFulltextData in interface com.lexmark.saperion.document.DocumentService
        Throws:
        com.lexmark.saperion.exceptions.EcmException