filenet.vw.api

Class VWJoinType

java.lang.Object

filenet.vw.api.VWJoinType

public final class VWJoinType
extends java.lang.Object

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.

See Also:

VWMapNode, VWStepDefinition, VWCompoundStepDefinition, VWSplitType

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
VWJoinType()

Method Summary

Modifier and Type	Method and Description
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

JOIN_TYPE_AND

public static final int JOIN_TYPE_AND

Value of 1. Indicates a join where work is received from multiple paths which must all be traversed. This is the complement to SPLIT_TYPE_AND, in the VWSplitType class.

See Also:

Constant Field Values

JOIN_TYPE_OR

public static final int JOIN_TYPE_OR

Value of 2. Indicates a branch where work will be received from one among more than one paths. This is the complement to SPLIT_TYPE_OR, in the VWSplitType class.

See Also:

Constant Field Values

JOIN_TYPE_NONE

public static final int JOIN_TYPE_NONE

Value of 3. Indicates there is no join at the step. Indicates that the step definition has a JoinType property containing "JOIN_TYPE_NONE". This is the complement to SPLIT_TYPE_NONE, in the VWSplitType class.

See Also:

Constant Field Values

Constructor Detail

VWJoinType

public VWJoinType()

Method Detail

getLocalizedString

public static java.lang.String getLocalizedString(int theJoinType)
                                           throws VWException

Gets a localized String representation of the join type.

Parameters:

theJoinType - An integer value associated with the join type value.

Returns:

The localized description of the join type.

Throws:

VWException - The method throws an exception if the join type specified in the theJoinType parameter is invalid.

isValid

public static boolean isValid(int theJoinType)

Checks whether or not the specified join type value is valid.

Parameters:

theJoinType - An integer value for the join type value to be validated.

Returns:

A Boolean value. The method returns true if integer value specified in the theJoinType parameter is valid; otherwise, the method returns false.