com.filenet.api.events

Interface DocumentLifecyclePolicy

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

    public interface DocumentLifecyclePolicy
extends RepositoryObject, ActionConsumer
    Represents the lifecycle policy for a document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes.

    To define the lifecycle states in a document lifecycle policy, create a DocumentState object for each lifecycle state that you want to define and add it to the DocumentStateList collection referenced by the DocumentState property. You can set the ResetLifecycleOnCheckin property to define whether a document, when it is checked in, is reset to the initial lifecycle state in its document lifecycle policy or not. To define the actions to be taken when a document's lifecycle state changes, create a DocumentLifecycleAction object and set the DocumentLifecycleAction property to reference it. With the PreseveDirectPermissions property, you can elect to either preserve a document's direct (non-inherited) access permissions or replace them with the document lifecycle policy's access permissions.

    Metadata

    Auditable: true
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: ReplicableClassDefinition
    IsDependent: false
    IsHidden: false
    Name: DisplayName
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: ActionConsumer
    See Also:
    DocumentState, DocumentLifecycleAction

    • Method Detail

      • get_ResetLifecycleOnCheckin

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

      • set_ResetLifecycleOnCheckin

        void set_ResetLifecycleOnCheckin(java.lang.Boolean value)
        Sets the value of the ResetLifecycleOnCheckin property. For more information, see ResetLifecycleOnCheckin Property.

      • get_PreserveDirectPermissions

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

      • set_PreserveDirectPermissions

        void set_PreserveDirectPermissions(java.lang.Boolean value)
        Sets the value of the PreserveDirectPermissions property. For more information, see PreserveDirectPermissions 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.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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