com.filenet.api.core

Interface Annotation

  • All Superinterfaces:
    CmHoldable, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

    public interface Annotation
extends RepositoryObject, CmHoldable, Replicable, Subscribable, IndependentlyPersistableObject
    Represents an annotation that can be applied to a document, folder, or custom object. An Annotation object allows you to link additional information to a containable object. You can modify and delete annotations independently of their annotated object. However, you cannot create versions of an annotation separately from the object with which it is associated. Document annotations are uniquely associated with a single document version; they are not versioned or carried forward when their document version is updated and a new version created. By design, an annotation is deleted whenever its associated parent object is deleted. Although an annotation receives its default security from both the annotation's class and parent object, you can apply security to an annotation that is different from the security applied to its parent.

    To create a new Annotation object and associate it with a document, use a document object's createAnnotation method. To create a new Annotation object and associate it with a folder or custom object, first use a Factory.Annotation.createInstance() method to create a new Annotation object, then set its AnnotatedObject property to reference the object to which you want it associated. An annotation's content data can be specified via its ContentElements collection.

    Metadata

    Auditable: true
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: ReplicableClassDefinition
    IsDependent: false
    IsHidden: false
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: CmHoldable

    • Method Detail

      • get_Creator

        java.lang.String get_Creator()
        Returns the value of the Creator property. For more information, see Creator Property.

      • set_Creator

        void set_Creator(java.lang.String value)
        Sets the value of the Creator property. For more information, see Creator Property.

      • get_DateCreated

        java.util.Date get_DateCreated()
        Returns the value of the DateCreated property. For more information, see DateCreated Property.

      • set_DateCreated

        void set_DateCreated(java.util.Date value)
        Sets the value of the DateCreated property. For more information, see DateCreated Property.

      • get_LastModifier

        java.lang.String get_LastModifier()
        Returns the value of the LastModifier property. For more information, see LastModifier Property.

      • set_LastModifier

        void set_LastModifier(java.lang.String value)
        Sets the value of the LastModifier property. For more information, see LastModifier Property.

      • get_DateLastModified

        java.util.Date get_DateLastModified()
        Returns the value of the DateLastModified property. For more information, see DateLastModified Property.

      • set_DateLastModified

        void set_DateLastModified(java.util.Date value)
        Sets the value of the DateLastModified property. For more information, see DateLastModified Property.

      • get_Id

        Id get_Id()
        Returns the value of the Id property. For more information, see Id Property.

      • get_Name

        java.lang.String get_Name()
        Returns the value of the Name property. For more information, see Name Property.

      • get_Owner

        java.lang.String get_Owner()
        Returns the value of the Owner property. For more information, see Owner Property.

      • set_Owner

        void set_Owner(java.lang.String value)
        Sets the value of the Owner property. For more information, see Owner Property.

      • get_StorageLocation

        java.lang.String get_StorageLocation()
        Deprecated. As of release 4.0.0.
        Returns the value of the StorageLocation property. For more information, see StorageLocation Property.

      • get_ContentSize

        java.lang.Double get_ContentSize()
        Returns the value of the ContentSize property. For more information, see ContentSize Property.

      • get_MimeType

        java.lang.String get_MimeType()
        Returns the value of the MimeType property. For more information, see MimeType Property.

      • set_MimeType

        void set_MimeType(java.lang.String value)
        Sets the value of the MimeType property. For more information, see MimeType Property.

      • get_DateContentLastAccessed

        java.util.Date get_DateContentLastAccessed()
        Returns the value of the DateContentLastAccessed property. For more information, see DateContentLastAccessed Property.

      • get_AnnotatedContentElement

        java.lang.Integer get_AnnotatedContentElement()
        Returns the value of the AnnotatedContentElement property. For more information, see AnnotatedContentElement Property.

      • set_AnnotatedContentElement

        void set_AnnotatedContentElement(java.lang.Integer value)
        Sets the value of the AnnotatedContentElement property. For more information, see AnnotatedContentElement Property.

      • get_DescriptiveText

        java.lang.String get_DescriptiveText()
        Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.

      • set_DescriptiveText

        void set_DescriptiveText(java.lang.String value)
        Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.

      • get_IndexationId

        Id get_IndexationId()
        Returns the value of the IndexationId property. For more information, see IndexationId Property.

      • get_CmIndexingFailureCode

        java.lang.Integer get_CmIndexingFailureCode()
        Returns the value of the CmIndexingFailureCode property. For more information, see CmIndexingFailureCode Property.

      • get_CmRetentionDate

        java.util.Date get_CmRetentionDate()
        Returns the value of the CmRetentionDate property. For more information, see CmRetentionDate Property.

      • set_CmRetentionDate

        void set_CmRetentionDate(java.util.Date value)
        Sets the value of the CmRetentionDate property. For more information, see CmRetentionDate Property.

      • get_CmIsMarkedForDeletion

        java.lang.Boolean get_CmIsMarkedForDeletion()
        Returns the value of the CmIsMarkedForDeletion property. For more information, see CmIsMarkedForDeletion Property.

      • accessContentStream

        java.io.InputStream accessContentStream(int element)
        Obtains read access, via an input stream, to the content data of a ContentTransfer content element associated with this document or annotation. The content data is fetched from the server. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data.
        Parameters:
        element - An int specifying the index of the content element to which the content data belongs.
        Returns:
        An InputStream object for reading content data.
        Throws:
        API_INDEX_OUT_OF_BOUNDS - if the element parameter specifies an invalid index.
        API_NO_CONTENT_ELEMENTS - if no content elements exist on this document or annotation.
        API_NOT_A_CONTENT_TRANSFER - if the content element is not a ContentTransfer object.
        See Also:
        ContentAccessRecordingLevel property, DateContentLastAccessed property

      • changeClass

        void changeClass(java.lang.String className)
        Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
        • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
        • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
        • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
        • Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.

        When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

        • The document has no current lifecycle policy.
        • The document is either a reservation object, or is the current version object and is not reserved.

        Changing the document class of a document object has no effect on the storage location of the document�s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer�s Guide.

        Parameters:
        className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
        Throws:
        E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.

      • moveContent

        void moveContent(StorageArea storageArea)
        Moves the content data of an object to a new storage area. For VersionSeries, this method moves the content for all associated document versions.

        After a successful call to the moveContent method, the content data is deleted from the original location unless the content data is IBM FileNet Content Federation Services for Image Services federated content. To enable deletion of IBM FileNet Content Federation Services for Image Services federated content from its original location, set the com.filenet.replication.EnableLegacyMoveContentBehaviour parameter to true for your application server. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters.

        You can force content to be encrypted, re-encrypted, or decrypted based on the current encryption configuration for the destination storage area. Likewise, you can force content to be compressed or decompressed based on the content compression configuration for the destination storage area. For more information, see Content encryption and Content compression.

        .
        Parameters:
        storageArea - A StorageArea object specifying the new storage area for this object's content data.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.