|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Not Implemented in CS Java Connector v3.0.
An object implementing theWorkflowTarget
interface is
an object to which a workflow can be attached.
Field Summary |
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 |
public WorkflowSubscriptions getWorkflowSubscriptions(int isolatedRegion)
Not Implemented in CS Java Connector v3.0.
Returns a collection ofWorkflowSubscription
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.
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.
WorkflowSubscriptions
collection that contains the
WorkflowSubscription
elements associated with this
WorkflowTarget
object for the specified isolated region.
public java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion, java.lang.String[] propNames)
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).
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.
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.
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.public java.lang.String getWorkflowSubscriptionsXML(int isolatedRegion, boolean getAllSubscriptions, java.lang.String[] propNames)
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.
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.
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 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |