FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface WorkflowTarget

All Superinterfaces:
BaseObject, java.io.Serializable, ValueObject
All Known Subinterfaces:
ClassDescription, ClassDescription, CustomObject, Document, Document, Folder, Folder, PublishRequest, PublishTemplate, StoredSearch, StyleTemplate, VersionSeries, WorkflowDefinition

public interface WorkflowTarget
extends BaseObject

Not Implemented in CS Java Connector v3.0.

An object implementing the WorkflowTarget interface is an object to which a workflow can be attached.


Field Summary
 
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
 
Method Summary
 WorkflowSubscriptions getWorkflowSubscriptions(int isolatedRegion)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion, boolean getAllSubscriptions, java.lang.String[] propNames)
          Returns a string in XML that represents the collection of WorkflowSubscription objects (and their requested properties) for which this WorkflowTarget object is the subscription's target object; also optionally returns the WorkflowSubscription objects for this WorkflowTarget object's class description.
 java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion, java.lang.String[] propNames)
          Returns a string in XML that represents the collection of WorkflowSubscription objects (and their requested properties) for which this WorkflowTarget object is the subscription's target object.
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 

Method Detail

getWorkflowSubscriptions

public WorkflowSubscriptions getWorkflowSubscriptions(int isolatedRegion)

Not Implemented in CS Java Connector v3.0.

Returns a collection of WorkflowSubscription objects for which this WorkflowTarget object is the subscription's target object.

The association of a workflow definition to a target object is referred to as linking. To link a target object to a workflow definition, you set the SubscriptionTarget property on a WorkflowSubscription object to the object implementing the WorkflowTarget interface and the WorkflowDefinition property to the workflow definition. An object can also be automatically linked to a workflow definition if it belongs to a class (or, for a Document object, is part of a version series) that is linked to a workflow definition.

Parameters:
isolatedRegion - An integer that represents the isolated region within a VW Service in the Process Engine. -1 specifies that the workflow is not in an isolated region.

Returns:
A WorkflowSubscriptions collection that contains the WorkflowSubscription elements associated with this WorkflowTarget object for the specified isolated region.


getWorkflowSubscriptionsXML

public java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion,
                                                    java.lang.String[] propNames)
Returns a string in XML that represents the collection of WorkflowSubscription objects (and their requested properties) for which this WorkflowTarget object is the subscription's target object.

If the propNames parameter is null or an empty array, this method returns all properties for the workflow subscriptions. If the array includes properties that do not exist for the workflow subscriptions, those properties are ignored (no exception is thrown).

The association of a workflow definition to a target object is referred to as linking. To link a target object to a workflow definition, you set the SubscriptionTarget property on a WorkflowSubscription object to the object implementing the WorkflowTarget interface, and the WorkflowDefinition property to the workflow definition. An object can also be automatically linked to a workflow definition if it belongs to a class (or, for a Document object, is part of a version series) that is linked to a workflow definition.

To return a string in XML that also includes representations of the WorkflowSubscription objects for this WorkflowTarget object's class description, call the getWorkflowSubscriptionsXML(isolatedRegion, getAllSubscriptions, propNames) form of this method.

Parameters:
isolatedRegion - An integer that represents the isolated region within a VW Service in the Process Engine. -1 specifies that the workflow is not in an isolated region.

propNames - A String array whose elements specify the symbolic names of the properties to retrieve. If null or an empty array, retrieves all properties. However, if you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.

Returns:
A String in XML that represents a WorkflowSubscriptions collection, which contains the WorkflowSubscription elements associated with this WorkflowTarget object for the specified isolated region. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

getWorkflowSubscriptionsXML

public java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion,
                                                    boolean getAllSubscriptions,
                                                    java.lang.String[] propNames)
Returns a string in XML that represents the collection of WorkflowSubscription objects (and their requested properties) for which this WorkflowTarget object is the subscription's target object; also optionally returns the WorkflowSubscription objects for this WorkflowTarget object's class description.

If the propNames parameter is null or an empty array, this method returns all properties for the workflow subscriptions. If the array includes properties that do not exist for the workflow subscriptions, those properties are ignored (no exception is thrown).

The association of a workflow definition to a target object is referred to as linking. To link a target object to a workflow definition, you set the SubscriptionTarget property on a WorkflowSubscription object to the object implementing the WorkflowTarget interface, and the WorkflowDefinition property to the workflow definition. An object can also be automatically linked to a workflow definition if it belongs to a class (or, for a Document object, is part of a version series) that is linked to a workflow definition.

If you set the getAllSubscriptions parameter to true, then the returned string also includes representations of the WorkflowSubscription objects for this WorkflowTarget object's class description. If the object implementing this WorkflowTarget object is a VersionSeries object, then the class description in question is the class description for the current document version in the version series.

Parameters:
isolatedRegion - An integer that represents the isolated region within a VW Service in the Process Engine. -1 specifies that the workflow is not in an isolated region.

getAllSubscriptions - If true, the returned string includes representations of the WorkflowSubscription objects for this WorkflowTarget object's class description. If the object implementing this WorkflowTarget object is a VersionSeries object, then the class description in question is the class description for the current released version (or, if none exists, the current version) in the version series.

propNames - A String array whose elements specify the symbolic names of the properties to retrieve. If null or an empty array, retrieves all properties. However, if you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.

Returns:
A String in XML that represents a WorkflowSubscriptions collection, which contains the WorkflowSubscription elements associated with this WorkflowTarget object (and, optionally, this WorkflowTarget object's class description) for the specified isolated region. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

FileNet Content Services
Java Connector v3.0