com.filenet.api.ondemand

Interface CmodReport

    • Method Detail

      • get_StoragePolicy

        StoragePolicy get_StoragePolicy()
        The storage policy for the document.

      • set_StoragePolicy

        void set_StoragePolicy(StoragePolicy value)
        The storage policy for the document. Settability Restrictions: None.

      • get_StorageArea

        StorageArea get_StorageArea()
        The Storage Area this object is stored in.

      • set_StorageArea

        void set_StorageArea(StorageArea value)
        The Storage Area this object is stored in. Settability Restrictions: This property is settable only on create.

      • get_ContentSize

        java.lang.Double get_ContentSize()
        The size (in bytes) of the captured content associated with this object.

      • get_ContentType

        java.lang.String get_ContentType()
        The MIME type of the content associated with the object.

      • set_ContentType

        void set_ContentType(java.lang.String value)
        The MIME type of the content associated with the object. Settability Restrictions: This property is settable only before a checkin.

      • get_DateContentLastAccessed

        java.util.Date get_DateContentLastAccessed()
        The date and time when this content of a document was last accessed.

      • get_CmRetentionDate

        java.util.Date get_CmRetentionDate()
        Specifies the earliest date at which the object may be deleted.

      • set_CmRetentionDate

        void set_CmRetentionDate(java.util.Date value)
        Specifies the earliest date at which the object may be deleted. Settability Restrictions: None.

      • set_SectionClass

        void set_SectionClass(CmodSectionClassDefinition value)
        The class of the section objects associated with the report. Settability Restrictions: This property is settable only on create.

      • get_Sections

        CmodAbstractSectionSet get_Sections()
        A collection of the sections associated with the report.

      • get_LoadId

        Id get_LoadId()
        Unique identifier for the batch in which the report was loaded.

      • set_LoadId

        void set_LoadId(Id value)
        Unique identifier for the batch in which the report was loaded. Settability Restrictions: None.

      • 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 Content Cortex Content Federation Services for Image Services federated content. To enable deletion of IBM Content Cortex 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.

      • setCaptureSource

        void setCaptureSource(java.io.InputStream source)
        Specifies an input stream as the source of content data for this object. 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 once all of the content data has been read by the server. The stream can safely be closed after you have called the save method of the independent object to which the content is being added..
        Parameters:
        source - An InputStream object specifying the source of the content data.
        Throws:
        E_NULL_OR_INVALID_PARAM_VALUE - if the source parameter is null.

      • 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.
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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