com.ibm.mm.sdk.common

Class dkAbstractDataObjectBase

  • java.lang.Object
    • com.ibm.mm.sdk.common.dkAbstractDataObjectBase
  • All Implemented Interfaces:
    dkDataObjectBase, java.io.Serializable
    Direct Known Subclasses:
    dkDataObject


    public abstract class dkAbstractDataObjectBase
    extends java.lang.Object
    implements dkDataObjectBase, java.io.Serializable
    Abstract base class for all CM8 data objects. This is the root of the CM8 data object hierarchy. Each data object maintains an EcmDocument instance that represents the underlying document.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected com.filenet.api.collection.ContentElementList contentElementList 
      protected com.filenet.api.core.ContentTransfer contentTransfer 
      protected com.filenet.api.core.Document document
      The underlying ECM document instance.
      protected com.filenet.api.core.Folder folder 
      protected com.filenet.api.core.ObjectStore objectStore 
      protected DKPid pid
      The PID (Persistent Identifier) for this data object.
      protected java.lang.String semanticType 
    • Constructor Summary

      Constructors 
      Modifier Constructor and Description
      protected dkAbstractDataObjectBase()
      Default constructor for creating an empty data object.
      protected dkAbstractDataObjectBase(com.filenet.api.core.Document document, com.filenet.api.core.ObjectStore objectStore)
      Constructs a data object wrapping a FileNet Document.
      protected dkAbstractDataObjectBase(com.filenet.api.core.Folder folder, com.filenet.api.core.ObjectStore objectStore)
      Constructs a data object wrapping a FileNet Folder.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      protected com.filenet.api.collection.ContentElementList getContentElementList()
      Gets the content element list for this data object.
      com.filenet.api.core.Document getDocument()
      Public accessor for the document field.
      com.filenet.api.core.Folder getFolder()
      Public accessor for the folder field.
      java.lang.Object getNativeObject()
      Public accessor for the native object.
      java.lang.Object getObject()
      Gets the native object reference.
      java.lang.String getSemanticType()
      Gets the semantic type of this data object.
      protected void setContentElementList(com.filenet.api.collection.ContentElementList contentElementList)
      Sets the content element list for this data object.
      void setDocument(com.filenet.api.core.Document document)
      Sets the underlying FileNet document.
      void setObject(java.lang.Object obj)
      Sets the native object reference.
      void setSemanticType(java.lang.String semanticType)
      Sets the semantic type of this data object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • document

        protected com.filenet.api.core.Document document
        The underlying ECM document instance. This is the single source of truth for document data.
      • folder

        protected com.filenet.api.core.Folder folder
      • objectStore

        protected com.filenet.api.core.ObjectStore objectStore
      • semanticType

        protected java.lang.String semanticType
      • contentTransfer

        protected com.filenet.api.core.ContentTransfer contentTransfer
      • contentElementList

        protected com.filenet.api.collection.ContentElementList contentElementList
      • pid

        protected DKPid pid
        The PID (Persistent Identifier) for this data object.
    • Constructor Detail

      • dkAbstractDataObjectBase

        protected dkAbstractDataObjectBase()
        Default constructor for creating an empty data object.
      • dkAbstractDataObjectBase

        protected dkAbstractDataObjectBase(com.filenet.api.core.Document document,
                                           com.filenet.api.core.ObjectStore objectStore)
        Constructs a data object wrapping a FileNet Document.
        Parameters:
        document - the FileNet document to wrap
        objectStore - the object store containing the document
      • dkAbstractDataObjectBase

        protected dkAbstractDataObjectBase(com.filenet.api.core.Folder folder,
                                           com.filenet.api.core.ObjectStore objectStore)
        Constructs a data object wrapping a FileNet Folder.
        Parameters:
        folder - the FileNet folder to wrap
        objectStore - the object store containing the folder
    • Method Detail

      • setDocument

        public void setDocument(com.filenet.api.core.Document document)
        Sets the underlying FileNet document.
        Parameters:
        document - the document to set
      • getSemanticType

        public java.lang.String getSemanticType()
        Gets the semantic type of this data object.

        The semantic type identifies the kind of object (e.g., DK_CM_DOCUMENT, DK_CM_FOLDER).

        Returns:
        the semantic type string
        See Also:
        DKConstant
      • setSemanticType

        public void setSemanticType(java.lang.String semanticType)
        Sets the semantic type of this data object.
        Parameters:
        semanticType - the semantic type to set
        See Also:
        DKConstant
      • setObject

        public void setObject(java.lang.Object obj)
        Sets the native object reference.

        This allows storing a reference to the underlying FileNet object.

        Parameters:
        obj - the native object to set
      • getObject

        public java.lang.Object getObject()
        Gets the native object reference.
        Returns:
        the native object
      • getNativeObject

        public java.lang.Object getNativeObject()
        Public accessor for the native object.
        Returns:
        The native FileNet object
      • getDocument

        public com.filenet.api.core.Document getDocument()
        Public accessor for the document field.
        Returns:
        The FileNet Document object
      • getFolder

        public com.filenet.api.core.Folder getFolder()
        Public accessor for the folder field.
        Returns:
        The FileNet Folder object
      • getContentElementList

        protected com.filenet.api.collection.ContentElementList getContentElementList()
        Gets the content element list for this data object.

        The content element list contains the content elements (files) associated with a document.

        Returns:
        the content element list, or null if not set
      • setContentElementList

        protected void setContentElementList(com.filenet.api.collection.ContentElementList contentElementList)
        Sets the content element list for this data object.
        Parameters:
        contentElementList - the content element list to set
Copyright © 2024 IBM Corporation

Copyright © 2024 IBM Corporation. All rights reserved.