com.ibm.cm8.p8.sdk.mimic.cm8

Interface CM8DocumentService

  • All Superinterfaces:
    com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
    All Known Implementing Classes:
    CM8ToFileNetAdapter

    public interface CM8DocumentService
extends com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
    CM8 Document Service - ECM API interface mimicking CM8 patterns using FileNet Document classes. Extends EcmService with CM8-specific property validation methods.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method and Description
      default void addDocumentAttributeWithItemArray(com.filenet.api.core.Document document, java.lang.String attributeName, java.lang.Object[] items) 
      default void addFolderAttributeWithItemArray(com.filenet.api.core.Folder folder, java.lang.String attributeName, java.lang.Object[] items) 
      default void addItemToDocumentAttribute(com.filenet.api.core.Document document, java.lang.String attributeName, java.lang.Object item) 
      default void addItemToFolderAttribute(com.filenet.api.core.Folder folder, java.lang.String attributeName, java.lang.Object item) 
      default void cancelCheckout(com.filenet.api.core.Document document)
      Cancels the checkout of a document.
      default void carryForwardFolderFiling(com.filenet.api.core.Document oldReleasedDocument, com.filenet.api.core.Document newReleasedDocument)
      Carries forward folder filing from an old released document to a new released document.
      default void connect(java.lang.String url, int portNo, int servicePortNo, java.lang.String userid, java.lang.String passwd, java.lang.String newPasswd, java.lang.String objectStoreName) 
      default void connect(java.lang.String url, int portNo, java.lang.String userId, java.lang.String password, java.lang.String newPassword, java.lang.String objectStoreName) 
      default com.filenet.api.core.VersionSeries fetchVersionSeries(java.lang.String versionSeriesId) 
      default java.lang.String generateDocumentXml(com.filenet.api.core.Document document, java.lang.String objectStoreName)
      Generates XML representation of a FileNet Document.
      default java.lang.String generateFolderXml(com.filenet.api.core.Folder folder, java.lang.String objectStoreName)
      Generates XML representation of a FileNet Folder.
      default com.filenet.api.collection.ClassDescriptionSet getAllClassDescriptions() 
      default java.util.List<com.filenet.api.core.Document> getAllVersions(com.filenet.api.core.Document document) 
      default com.filenet.api.collection.StringList getAttrValues(com.filenet.api.core.Document document) 
      default com.filenet.api.collection.StringList getAttrValues(com.filenet.api.core.Folder folder) 
      default com.filenet.api.meta.ClassDescription getClassDescriptionByName(java.lang.String className) 
      default int getContentCount(com.filenet.api.core.Document document) 
      default java.util.List<java.lang.String> getDocumentPropertyNames(com.filenet.api.core.Document document) 
      default java.util.List<java.lang.String> getFolderPropertyNames(com.filenet.api.core.Folder folder) 
      com.filenet.api.core.ObjectStore getObjectStore() 
      default boolean isChildComponentsAsAttributes() 
      default java.io.InputStream retrieveDocumentContentFromObject(com.filenet.api.core.Document document) 
      default com.filenet.api.core.Document setDocumentPropertyObjectValue(com.filenet.api.core.Document document, java.lang.String propertyName, java.lang.Object[] value) 
      default com.filenet.api.core.Folder setFolderPropertyObjectValue(com.filenet.api.core.Folder folder, java.lang.String propertyName, java.lang.Object[] value) 
      default int unfileAllFolderContents(com.filenet.api.core.Folder folder)
      Unfiles all contents from a folder.

      • Methods inherited from interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

        addContentToDocument, addContentTransferToContenList, addMemberToFolder, applyVersioning, batchDeleteObjects, checkinDocument, checkinDocument, checkoutDocument, connect, connect, createContentElementList, createContentTransfer, createDocumentInstance, createFolderInstance, deleteDocument, deleteFolder, disconnect, ensureUserContext, executeCountQuery, executeQuery, executeRowQuery, fetchObjectStoreInstance, fileDocumentIntoFolder, fileDocumentIntoFolderItem, getClassDescriptionForDocument, getClassDescriptions, getConnection, getContentSize, getCreatedTimestamp, getDataCount, getDocument, getDocumentProperty, getDomain, getFilteredPropertyNamesForClass, getFolder, getFolderProperty, getMimeType, getObjectStoreName, getObjectStores, getObjectType, getObjectType, getOriginalFileName, getParentFolders, getPartNumber, getPropertyDescriptionsForClass, getPropertyNamesForClass, getReferencedTimestamp, getRMName, getRootFolder, getUpdatedTimestamp, getUserName, getVersionNumber, isConnected, isContentChanged, propertyExists, retrieveDocumentContent, saveContainmentRelationship, saveDocument, saveDocument, saveFolder, saveFolder, setCaptureSource, setContentRetrievalName, setContentToNull, setDocumentProperty, setDocumentProperty, setDocumentPropertyObject, setFolderProperty, setFolderProperty, setFolderPropertyObject, setMimeType, unfileDocumentFromFolder, updateFromFilePathNew, updateFromInputStreamNew

    • Method Detail

      • getObjectStore

        com.filenet.api.core.ObjectStore getObjectStore()
        Specified by:
        getObjectStore in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getDocumentPropertyNames

        default java.util.List<java.lang.String> getDocumentPropertyNames(com.filenet.api.core.Document document)
        Specified by:
        getDocumentPropertyNames in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getFolderPropertyNames

        default java.util.List<java.lang.String> getFolderPropertyNames(com.filenet.api.core.Folder folder)
        Specified by:
        getFolderPropertyNames in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • connect

        default void connect(java.lang.String url,
                     int portNo,
                     int servicePortNo,
                     java.lang.String userid,
                     java.lang.String passwd,
                     java.lang.String newPasswd,
                     java.lang.String objectStoreName)
        Specified by:
        connect in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • connect

        default void connect(java.lang.String url,
                     int portNo,
                     java.lang.String userId,
                     java.lang.String password,
                     java.lang.String newPassword,
                     java.lang.String objectStoreName)
        Specified by:
        connect in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getAttrValues

        default com.filenet.api.collection.StringList getAttrValues(com.filenet.api.core.Document document)
        Specified by:
        getAttrValues in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getAttrValues

        default com.filenet.api.collection.StringList getAttrValues(com.filenet.api.core.Folder folder)
        Specified by:
        getAttrValues in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • addItemToDocumentAttribute

        default void addItemToDocumentAttribute(com.filenet.api.core.Document document,
                                        java.lang.String attributeName,
                                        java.lang.Object item)
        Specified by:
        addItemToDocumentAttribute in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • addItemToFolderAttribute

        default void addItemToFolderAttribute(com.filenet.api.core.Folder folder,
                                      java.lang.String attributeName,
                                      java.lang.Object item)
        Specified by:
        addItemToFolderAttribute in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • setDocumentPropertyObjectValue

        default com.filenet.api.core.Document setDocumentPropertyObjectValue(com.filenet.api.core.Document document,
                                                                     java.lang.String propertyName,
                                                                     java.lang.Object[] value)
        Specified by:
        setDocumentPropertyObjectValue in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • setFolderPropertyObjectValue

        default com.filenet.api.core.Folder setFolderPropertyObjectValue(com.filenet.api.core.Folder folder,
                                                                 java.lang.String propertyName,
                                                                 java.lang.Object[] value)
        Specified by:
        setFolderPropertyObjectValue in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • addDocumentAttributeWithItemArray

        default void addDocumentAttributeWithItemArray(com.filenet.api.core.Document document,
                                               java.lang.String attributeName,
                                               java.lang.Object[] items)
        Specified by:
        addDocumentAttributeWithItemArray in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • addFolderAttributeWithItemArray

        default void addFolderAttributeWithItemArray(com.filenet.api.core.Folder folder,
                                             java.lang.String attributeName,
                                             java.lang.Object[] items)
        Specified by:
        addFolderAttributeWithItemArray in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • isChildComponentsAsAttributes

        default boolean isChildComponentsAsAttributes()
        Specified by:
        isChildComponentsAsAttributes in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getAllClassDescriptions

        default com.filenet.api.collection.ClassDescriptionSet getAllClassDescriptions()
        Specified by:
        getAllClassDescriptions in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getClassDescriptionByName

        default com.filenet.api.meta.ClassDescription getClassDescriptionByName(java.lang.String className)
        Specified by:
        getClassDescriptionByName in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • retrieveDocumentContentFromObject

        default java.io.InputStream retrieveDocumentContentFromObject(com.filenet.api.core.Document document)
        Specified by:
        retrieveDocumentContentFromObject in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • getAllVersions

        default java.util.List<com.filenet.api.core.Document> getAllVersions(com.filenet.api.core.Document document)
                                                              throws java.lang.Exception
        Specified by:
        getAllVersions in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
        Throws:
        java.lang.Exception

      • getContentCount

        default int getContentCount(com.filenet.api.core.Document document)
        Specified by:
        getContentCount in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService

      • unfileAllFolderContents

        default int unfileAllFolderContents(com.filenet.api.core.Folder folder)
                             throws java.lang.Exception
        Unfiles all contents from a folder. Default implementation returns 0 (no items unfiled). Override in implementation class to provide actual unfiling logic.
        Specified by:
        unfileAllFolderContents in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
        Parameters:
        folder - the FileNet P8 Folder to clear
        Returns:
        the number of items unfiled (default: 0)
        Throws:
        java.lang.Exception - if unfiling fails

      • fetchVersionSeries

        default com.filenet.api.core.VersionSeries fetchVersionSeries(java.lang.String versionSeriesId)

      • cancelCheckout

        default void cancelCheckout(com.filenet.api.core.Document document)
        Cancels the checkout of a document. Default implementation does nothing. Override in implementation class to provide actual cancel checkout logic.
        Specified by:
        cancelCheckout in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
        Parameters:
        document - the FileNet P8 Document to cancel checkout for

      • carryForwardFolderFiling

        default void carryForwardFolderFiling(com.filenet.api.core.Document oldReleasedDocument,
                                      com.filenet.api.core.Document newReleasedDocument)
                               throws java.lang.Exception
        Carries forward folder filing from an old released document to a new released document. Default implementation does nothing. Override in implementation class to provide actual carry forward logic.
        Parameters:
        oldReleasedDocument - the old released document
        newReleasedDocument - the new released document
        Throws:
        java.lang.Exception - if carry forward fails

      • generateDocumentXml

        default java.lang.String generateDocumentXml(com.filenet.api.core.Document document,
                                             java.lang.String objectStoreName)
        Generates XML representation of a FileNet Document. Default implementation returns null. Override in implementation class to provide actual XML generation logic.
        Specified by:
        generateDocumentXml in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
        Parameters:
        document - the FileNet P8 Document to generate XML for
        objectStoreName - the name of the object store
        Returns:
        XML string representation of the document

      • generateFolderXml

        default java.lang.String generateFolderXml(com.filenet.api.core.Folder folder,
                                           java.lang.String objectStoreName)
        Generates XML representation of a FileNet Folder. Default implementation returns null. Override in implementation class to provide actual XML generation logic.
        Specified by:
        generateFolderXml in interface com.ibm.cm8.p8.sdk.mimic.core.service.EcmService
        Parameters:
        folder - the FileNet P8 Folder to generate XML for
        objectStoreName - the name of the object store
        Returns:
        XML string representation of the folder
Skip navigation links
Copyright © 2024 IBM Corporation
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

Copyright © 2024 IBM Corporation. All rights reserved.