FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface WorkflowDefinition

All Superinterfaces:
BaseObject, ContainableObject, CreatableObject, Document, GettableObject, LockableObject, ReadableMetadataObject, ReadableSecurityObject, java.io.Serializable, ValueObject, VersionableObject, WorkflowTarget, WriteableMetadataObject, WriteableSecurityObject

public interface WorkflowDefinition
extends Document

Not Implemented in CS Java Connector v3.0.

A WorkflowDefinition object is a document that contains the definition of a workflow. The WorkflowDefinition interface extends the Document interface, and adds one method (getWorkflowSourceSubscriptions) and one property (VWVersion).

A workflow definition is an XML document of class "WorkflowDefinition" and is stored in a Content Services object store. It 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.

Note that because a workflow definition is also a document, it 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 Services object store, call either the createObject or the createAndFileObject method on an ObjectStore object. (Note, however, that although the createAndFileObject method creates the object, checks it in, and files it into a folder in one roundtrip to the server, it does not support setting content. To have a viable workflow definition you would need to check out the object after you create it, set its content, and check it back in.)

After you create a workflow definition, you link it to an object that implements the WorkflowTarget interface by setting the SubscriptionTarget and WorkflowDefinition properties on a WorkflowSubscription object. Note that you cannot delete a WorkflowDefinition object if a WorkflowSubscription object refers to it in its WorkflowDefinition property.

To return all of the WorkflowSubscription objects associated with this WorkflowDefinition object, call the getWorkflowSourceSubscriptions method.

You can instantiate a WorkflowDefinition object in the following ways:


Field Summary
 
Fields inherited from interface com.filenet.wcm.api.Document
LIFECYCLE_CLEAR_EXCEPTION, LIFECYCLE_DEMOTE, LIFECYCLE_NO_CHANGE, LIFECYCLE_PROMOTE, LIFECYCLE_RESET, LIFECYCLE_SET_EXCEPTION, UNKNOWN_CONTENT_LENGTH
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Fields inherited from interface com.filenet.wcm.api.ContainableObject
INVALID_CONTAINMENT_NAME_CHARACTERS
 
Fields inherited from interface com.filenet.wcm.api.VersionableObject
APPLY_STATE_ID_IN_PROCESS, APPLY_STATE_ID_RELEASED, APPLY_STATE_ID_RESERVATION, APPLY_STATE_ID_SUPERSEDED, RESERVATION_TYPE_COLLABORATIVE, RESERVATION_TYPE_DEFAULT, RESERVATION_TYPE_EXCLUSIVE, VERSION_STATUS_IN_PROCESS, VERSION_STATUS_RELEASED, VERSION_STATUS_RESERVATION, VERSION_STATUS_SUPERSEDED
 
Method Summary
 WorkflowSubscriptions getWorkflowSourceSubscriptions()
          

Not Implemented in CS Java Connector v3.0.

 
Methods inherited from interface com.filenet.wcm.api.Document
applySecurityTemplate, applySecurityTemplate, canDemoteLifeCycleState, changeClass, changeLifeCycleState, delete, delete, getAccessMask, getContent, getContentElement, getContentElementObjectTypes, getContentReferenceLocation, getContentReferenceLocation, getContentReferenceMimeType, getContentReferenceMimeType, getFilename, getFilename, getHeadLinks, getHeadLinksXML, getLifeCycleStates, getPermissionsXML, getPublications, getPublicationsXML, getPublishTemplates, getPublishTemplatesXML, getSecurityPolicyXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, getUserAccess, getUserAccessXML, getVersionSeries, getVersionsXML, isDependent, isPublication, publish, raiseEvent, republish, setContent, setContentReference
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.ContainableObject
file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
 
Methods inherited from interface com.filenet.wcm.api.VersionableObject
cancelCheckout, checkin, checkin, checkout, checkout, demoteVersion, freeze, getReservation, getVersions, getVersions, promoteVersion
 
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
 
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject
setPermissions, setPermissions
 
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject
getPermissions, getPermissions
 
Methods inherited from interface com.filenet.wcm.api.LockableObject
extendLock, extendLock, isLocked, lock, unlock, unlock
 

Method Detail

getWorkflowSourceSubscriptions

public WorkflowSubscriptions getWorkflowSourceSubscriptions()

Not Implemented in CS Java Connector v3.0.

Returns a WorkflowSubscriptions collection, the elements of which are the WorkflowSubscription objects associated with this WorkflowDefinition object.

Returns:
A WorkflowSubscriptions collection containing all the WorkflowSubscription elements whose WorkflowDefinition property refers to this WorkflowDefinition object.

FileNet Content Services
Java Connector v3.0