com.filenet.api.core

Interface CmTaskRelationship

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

    public interface CmTaskRelationship
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
    Defines a predecessor-successor relationship between two CmTask objects. A CmTask object can be referenced by more than one instance of this class, and, consequently, can be designated as a CmTask object in more than one relationship. This capability allows many-to-many predecessor-successor associations to be maintained between tasks. Given that a process can consist of multiple tasks that are coordinated by the same business object, the CmTaskRelationship objects referencing these tasks collectively define the overall sequencing of the process.

    A CmTaskRelationship object is subject to the following constraints:

    • The predecessor and successor must be different CmTask objects.
    • Both referenced CmTask objects must have the same coordinator.
    • Cycles are not permitted in the relationships between tasks. For example, you cannot have task relationships where TaskA has TaskB as a successor and TaskB has TaskA as successor.
    • At most, one CmTaskRelationship is allowed for a given predecessor-successor task pair.

    Created with a Factory method, a CmTaskRelationship object is independently persistable. However, it is not independently securable; it takes its security from the predecessor CmTask object. For example, users with write permission to the predecessor CmTask object have the same right to the CmTaskRelationship object referenceing the predecessor. Permission to delete a CmTaskRelationship object requires deletion rights on the predecessor CmTask object. Deletion of a CmTaskRelationship object does not delete the predecessor-successor CmTask objects referenced by the CmTaskRelationship object .

    Note that deletion of a task cascades to any task relationships referencing that task as either a predecessor or successor, but the deletion does not cascade through the task relationships to other referenced tasks.

    For more information, see Task Concepts.

    Metadata

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

    • 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_PredecessorTask

        CmTask get_PredecessorTask()
        Returns the value of the PredecessorTask property. For more information, see PredecessorTask Property.

      • set_PredecessorTask

        void set_PredecessorTask(CmTask value)
        Sets the value of the PredecessorTask property. For more information, see PredecessorTask Property.

      • get_SuccessorTask

        CmTask get_SuccessorTask()
        Returns the value of the SuccessorTask property. For more information, see SuccessorTask Property.

      • set_SuccessorTask

        void set_SuccessorTask(CmTask value)
        Sets the value of the SuccessorTask property. For more information, see SuccessorTask Property.

      • get_CmDefinesAlternatePredecessor

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

      • set_CmDefinesAlternatePredecessor

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

      • get_CmIsMarkedForDeletion

        java.lang.Boolean get_CmIsMarkedForDeletion()
        Returns the value of the CmIsMarkedForDeletion property. For more information, see CmIsMarkedForDeletion 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.