com.filenet.api.core
Interface WorkflowDefinition

All Superinterfaces:
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:

Metadata

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


Method Summary
 java.lang.String get_VWVersion()
          Returns the value of the VWVersion property.
 SubscriptionSet get_WorkflowSourceSubscriptions()
          Returns the value of the WorkflowSourceSubscriptions property.
 void set_VWVersion(java.lang.String value)
          Sets the value of the VWVersion property.
 
Methods inherited from interface com.filenet.api.core.Document
accessContentStream, applySecurityTemplate, changeState, checkin, get_ChildDocuments, get_ChildRelationships, get_ClassificationStatus, get_CompoundDocumentState, get_ContentElements, get_ContentElementsPresent, get_ContentRetentionDate, get_ContentSize, get_CurrentState, get_CurrentVersion, get_DateContentLastAccessed, get_DependentDocuments, get_DestinationDocuments, get_DocumentLifecyclePolicy, get_IndexationId, get_IsInExceptionState, get_MimeType, get_OwnerDocument, get_ParentDocuments, get_ParentRelationships, get_PublicationInfo, get_PublishingSubsidiaryFolder, get_ReleasedVersion, get_SecurityParent, get_SourceDocument, get_StorageArea, get_StorageLocation, get_StoragePolicy, get_WorkflowSubscriptions, getPublicationStatus, isLocked, lock, moveContent, publish, republish, set_CompoundDocumentState, set_ContentElements, set_DocumentLifecyclePolicy, set_MimeType, set_OwnerDocument, set_PublicationInfo, set_PublishingSubsidiaryFolder, set_SecurityParent, set_SourceDocument, set_StorageArea, set_StoragePolicy, takeFederatedOwnership, unlock, updateLock
 
Methods inherited from interface com.filenet.api.core.Versionable
cancelCheckout, changeClass, checkout, createAnnotation, demoteVersion, freeze, get_DateCheckedIn, get_FoldersFiledIn, get_IsCurrentVersion, get_IsFrozenVersion, get_IsReserved, get_IsVersioningEnabled, get_MajorVersionNumber, get_MinorVersionNumber, get_Reservation, get_ReservationType, get_SecurityFolder, get_Versions, get_VersionSeries, get_VersionStatus, promoteVersion, set_DateCheckedIn, set_SecurityFolder
 
Methods inherited from interface com.filenet.api.core.Containable
get_ActiveMarkings, get_Annotations, get_AuditedEvents, get_Containers, get_Creator, get_DateCreated, get_DateLastModified, get_Id, get_LastModifier, get_LockOwner, get_LockTimeout, get_LockToken, get_Name, get_Owner, get_Permissions, get_SecurityPolicy, set_Creator, set_DateCreated, set_DateLastModified, set_LastModifier, set_Owner, set_Permissions, set_SecurityPolicy
 
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

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.


get_WorkflowSourceSubscriptions

SubscriptionSet get_WorkflowSourceSubscriptions()
Returns the value of the WorkflowSourceSubscriptions property. For more information, see WorkflowSourceSubscriptions Property.



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