|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWJoinType
public final class VWJoinType
Use this class to access the join type for branching of the workflow. The join type is a property of a step in a workflow graph which has multiple execution routes. "AND" joins indicate parallel routing (work comes from more than one path), while "OR" joins indicate branching (the work comes from one among two or more route paths).
When creating splits and joins on steps, associate "AND" splits with "AND" joins, further down a route path. Similarly associate "OR" splits with "OR" joins, further down a route path.
For a given VWStepDefinition or VWCompoundStepDefinition, this class allows you to set the integer value of the JoinType property. The integer value must correspond to one of the following VWJoinType types:
Input this: | To set this type: | Result: |
1 | JOIN_TYPE_AND | Work flows from multiple routes into a join in which all the split paths must be traversed. |
2 | JOIN_TYPE_OR | Work flows from multiple routes into a join in which only one of the split paths is traversed. |
3 | JOIN_TYPE_NONE | There is no join at the step. |
VWMapNode
,
VWStepDefinition
,
VWCompoundStepDefinition
,
VWSplitType
Field Summary | |
---|---|
static int |
JOIN_TYPE_AND
Value of 1. Indicates a join where work is received from multiple paths which must all be traversed. |
static int |
JOIN_TYPE_NONE
Value of 3. Indicates there is no join at the step. |
static int |
JOIN_TYPE_OR
Value of 2. Indicates a branch where work will be received from one among more than one paths. |
Constructor Summary | |
---|---|
VWJoinType()
|
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
static java.lang.String |
getLocalizedString(int theJoinType)
Gets a localized String representation of the join type. |
static boolean |
isValid(int theJoinType)
Checks whether or not the specified join type value is valid. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int JOIN_TYPE_AND
VWSplitType
class.
public static final int JOIN_TYPE_OR
VWSplitType
class.
public static final int JOIN_TYPE_NONE
VWSplitType
class.
Constructor Detail |
---|
public VWJoinType()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public static java.lang.String getLocalizedString(int theJoinType) throws VWException
theJoinType
- An integer value associated with the join
type value.
VWException
- The method throws an exception if the
join type specified in the theJoinType parameter is invalid.public static boolean isValid(int theJoinType)
theJoinType
- An integer value for the join type value to
be validated.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |