Process Class Relationships

filenet.vw.api
Class VWSplitType

java.lang.Object
  |
  +--filenet.vw.api.VWSplitType

public final class VWSplitType
extends java.lang.Object

Use this class to access the split type for branching of the workflow. The split type is a property of a step in a workflow graph which has multiple execution routes. "AND" splits indicate parallel routing (work goes down more than one path), while "OR" splits indicate branching (the work proceeds down 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 SplitType property. The integer value must correspond to one of the following VWSplitType types:

Input this: To set this type: Result:
1 SPLIT_TYPE_AND Work flows into multiple routes which all must be traversed.
2 SPLIT_TYPE_OR Work flows into multiple routes, but only one among them is traversed.
3 SPLIT_TYPE_NONE There is no split at the step.

See Also:
VWMapNode, VWStepDefinition, VWCompoundStepDefinition, VWJoinType

Field Summary
static int SPLIT_TYPE_AND
          Integer value of 1. Indicates a split where work will be routed, in parallel, over multiple paths which must all be traversed.
static int SPLIT_TYPE_NONE
          Integer value of 3. Indicates there is no split at the step.
static int SPLIT_TYPE_OR
          Integer value of 2. Indicates a branch where work will be routed to one among more than one paths.
 
Constructor Summary
VWSplitType()
           
 
Method Summary
static java.lang.String getLocalizedString(int theSplitType)
          Gets a localized string representation of the split type.
static boolean isValid(int theSplitType)
          Determines whether or not the split type is in range.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SPLIT_TYPE_AND

public static final int SPLIT_TYPE_AND
Integer value of 1. Indicates a split where work will be routed, in parallel, over multiple paths which must all be traversed. This is the complement to JOIN_TYPE_AND, in the VWJoinType class.

SPLIT_TYPE_OR

public static final int SPLIT_TYPE_OR
Integer value of 2. Indicates a branch where work will be routed to one among more than one paths. This is the complement to JOIN_TYPE_OR, in the VWJoinType class.

SPLIT_TYPE_NONE

public static final int SPLIT_TYPE_NONE
Integer value of 3. Indicates there is no split at the step. Indicates that a step definition has a SplitType property containing "SPLIT_TYPE_NONE". This is the complement to JOIN_TYPE_NONE, in the VWJoinType class.
Constructor Detail

VWSplitType

public VWSplitType()
Method Detail

getLocalizedString

public static java.lang.String getLocalizedString(int theSplitType)
                                           throws VWException
Gets a localized string representation of the split type.
Parameters:
theSplitType - An integer value indicating the split type value to be represented by a string. Valid split type values are as follows:

  • 1: And (SPLIT_TYPE_AND)
  • 2: Or (SPLIT_TYPE_OR)
  • 3: None (SPLIT_TYPE_NONE)

Returns:
The localized text representation of the split type.
Throws:
VWException - The method throws an exception if the split type value specified in the theSplitType parameter is invalid.

isValid

public static boolean isValid(int theSplitType)
Determines whether or not the split type is in range.
Parameters:
theSplitType - An integer value for the split type to be validated.
Returns:
A Boolean value. The method returns true if the split type specified theSplitType is valid; otherwise, the method returns false.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.