filenet.vw.api

Class VWNodeType

java.lang.Object

filenet.vw.api.VWNodeType

public final class VWNodeType
extends java.lang.Object

Use this class to classify the nodes on a map into the following categories:

• Launch
• Start
• Other

You can query an object derived from VWMapNode to find out its node type. This is useful in situations where, for example, a step must receive special processing to be displayed, depending on its node type.

See Also:

VWMapNode, VWStepDefinition, VWCompoundStepDefinition, VWMapNode.getNodeType()

Field Summary

Fields

Modifier and Type	Field and Description
static int	NODE_TYPE_LAUNCH Value of 1 The node is a launch node, which is the first step in the main workflow definition map, which is called "Workflow".
static int	NODE_TYPE_OTHER Value of 3 The node is neither a start nor a launch node.
static int	NODE_TYPE_START Value of 2 The node is a start node, which is the first step in any workflow definition map other than the main map.

Constructor Summary

Constructors

Constructor and Description
VWNodeType()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLocalizedString(int theNodeType) Get a localized String representation of the node type.
static boolean	isValid(int theNodeType) Returns whether or not the node type is valid.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODE_TYPE_LAUNCH

public static final int NODE_TYPE_LAUNCH

Value of 1
The node is a launch node, which is the first step in the main workflow definition map, which is called "Workflow".

See Also:

Constant Field Values

NODE_TYPE_START

public static final int NODE_TYPE_START

Value of 2
The node is a start node, which is the first step in any workflow definition map other than the main map.

See Also:

Constant Field Values

NODE_TYPE_OTHER

public static final int NODE_TYPE_OTHER

Value of 3
The node is neither a start nor a launch node.

See Also:

Constant Field Values

Constructor Detail

VWNodeType

public VWNodeType()

Method Detail

getLocalizedString

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

Get a localized String representation of the node type.

Parameters:

theNodeType - Node type value to be represented by a string

Returns:

A localized string, representing the node type

Throws:

VWException - Thrown if the node type is invalid.

isValid

public static boolean isValid(int theNodeType)

Returns whether or not the node type is valid.

Parameters:

theNodeType - The node type value to be validated.

Returns:

A boolean value: true if theNodeType input parameter is valid, false otherwise