com.filenet.api.core

Interface WorkflowDefinition

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

    public interface WorkflowDefinition
extends RepositoryObject, Document
    Represents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. A workflow definition describes the instructions, paths, and queues available to a workflow, and acts as a processing template that the Process Engine uses each time the workflow runs. Workflow definition documents are versionable, containable, and can have a lifecycle associated with them.

    The WorkflowDefinition interface extends the Document interface, and can, therefore, be treated as a Document object. For example, a WorkflowDefinition object can have workflows linked to it. Therefore, a user selecting a workflow definition can either launch it, or launch a linked workflow.

    To create a new WorkflowDefinition object and persist it to a Content Engine object store, call the createInstance method on the Factory.WorkflowDefinition class.

    After you create a workflow definition, you link it to an object that implements the Subscribable interface by setting the SubscriptionTarget and WorkflowDefinition properties on a workflow subscription object (InstanceWorkflowSubscription or ClassWorkflowSubscription object). Note that you cannot delete a WorkflowDefinition object if a workflow subscription object refers to it in its WorkflowDefinition property.

    To return all of the workflow subscription objects associated with this WorkflowDefinition object, call the get_WorkflowSourceSubscriptions method.

    You can instantiate a WorkflowDefinition object in the following ways:

    • By calling the getInstance or fetchInstance method on the Factory.WorkflowDefinition class.
    • By calling the get_WorkflowDefinition method on a workflow subscription object.
    • By instantiating a WorkflowDefinitionSet collection, then returning a WorkflowDefinition object from the collection.

    Metadata

    Auditable: undefined
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: DocumentClassDefinition
    IsDependent: false
    IsHidden: true
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: Document

    • Method Detail

      • get_VWVersion

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

      • set_VWVersion

        void set_VWVersion(java.lang.String value)
        Sets the value of the VWVersion property. For more information, see VWVersion Property.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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