Process Class Relationships

filenet.vw.api
Class VWMapNode

java.lang.Object
  |
  +--filenet.vw.api.VWMapNode
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
VWCompoundStepDefinition, VWStepDefinition

public abstract class VWMapNode
extends java.lang.Object
implements java.io.Serializable

VWMapNode is an abstract base class which encapsulates the routing, location, and other properties that relate to the of steps of a map. This class excludes step properties like parameters or participants, which do not define the step relative to a map. This package includes classes that have been extended to produce the different types of steps that a map contains, like the step definition classes VWStepDefinition and VWCompoundStepDefinition.

Since:
VWWS4.20
See Also:
VWMapDefinition, VWRouteDefinition, VWStepDefinition, VWCompoundStepDefinition, VWJoinType, VWSplitType, VWException, Serialized Form

Field Summary
static int POST_RULESETS
          Value of 2, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).
static int PRE_RULESETS
          Value of 0, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).
static int UPDATE_RULESETS
          Value of 1, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).
 
Method Summary
 VWRouteDefinition createRoute(int theDestinationId)
          Creates an outbound route for the current step. This step will be the implicit source step for the route.
 void deleteRoute(int theRouteId)
          Deletes an outbound route from this step.
 java.lang.String getDescription()
          Gets the value of the current node's description property.
 int getJoinType()
          Gets the value of this step's JoinType property.
 java.awt.Point getLocation()
          Gets the value of the location property associated with this step.
 java.lang.String getName()
          Gets the value of the current node's name property.
 VWRouteDefinition[] getNextRoutes()
          Gets the definition of each outbound route associated with the current node.
 int getNodeType()
          Returns the value of the map node type.
 VWRouteDefinition[] getPreviousRoutes()
          Gets the definition of each inbound route associated with this step.
 VWRouteDefinition getRoute(int theRouteId)
          Gets the route definition object specified by the route ID parameter.
 VWRouteDefinition getRouteFrom(int theSourceStepId)
          Gets the inbound route from another step.
 VWRouteDefinition getRouteTo(int theDestinationStepId)
          Gets the outbound route to another step.
 VWRuleSetDefinition[] getRuleSets(int ruleSetSelector)
          Retrieves the array of VWRuleSetDefinition objects for this step definition of the type, specified by the ruleSetSelector parameter.
 int getSplitType()
          Gets the step's split type.
 int getStepId()
          Gets the value of this step's stepId property.
 void reorderRoutes(int[] theRouteOrder)
          Changes the order in which the system stores outbound routes in this map node.
 void setDescription(java.lang.String theDescription)
          Changes the value of the current node's description property.
 void setJoinType(int theJoinType)
          Changes the value of this step's JoinType property.
 void setLocation(java.awt.Point theLocation)
          Sets the value of the location property associated with this step.
 void setName(java.lang.String theName)
          Changes the value of the current node's name property.
 void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules)
          Sets the VWRuleSetDefinitions for this step definition.
 void setSplitType(int theSplitType)
          Changes the value of this step's SplitType property.
abstract  java.lang.String toString()
          Gets a string representation of this map node object, typically used for debug echo statements.
abstract  void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWMapNode object to the buffer specified by the input parameter.
abstract  void validate(VWSession theSession, java.util.Vector EDefVector)
          Validates this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PRE_RULESETS

public static final int PRE_RULESETS
Value of 0, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).

UPDATE_RULESETS

public static final int UPDATE_RULESETS
Value of 1, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).

POST_RULESETS

public static final int POST_RULESETS
Value of 2, for use with getRuleSets(int) and setRuleSets(int, VWRuleSetDefinition []).
Method Detail

validate

public abstract void validate(VWSession theSession,
                              java.util.Vector EDefVector)
                       throws VWException
Validates this object.

A session object is required to perform certain parts of the validation process. You can either pass in a valid VWSession object or null for the input parameter. If you pass null, validation tests that require a logon will not be reported as validated.

The Vector object specified by the EDefVector input parameter may already contain some validation errors from previous validation calls for other objects. During execution, this method detects validation errors and appends them to that existing Vector object.

Parameters:
theSession - The session object, or null (if you are not logged on).
EDefVector - a Vector to which this method appends any VWValidationErrors found during this call.
Throws:
VWException - Thrown if a system error occurs during the validation.

toXML

public abstract void toXML(java.lang.StringBuffer theBuffer)
                    throws VWException
Appends an XML string that represents this VWMapNode object to the buffer specified by the input parameter.
Parameters:
theBuffer - A String buffer to which this method will append XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

toString

public abstract java.lang.String toString()
Gets a string representation of this map node object, typically used for debug echo statements.
Overrides:
toString in class java.lang.Object

getName

public java.lang.String getName()
Gets the value of the current node's name property.
Returns:
Name of the current node

setName

public void setName(java.lang.String theName)
             throws VWException
Changes the value of the current node's name property.
Parameters:
theName - New name of the current node
Throws:
VWException - Thrown if the name is null or invalid

getDescription

public java.lang.String getDescription()
Gets the value of the current node's description property.
Returns:
Description of the current node: null if the description is null

setDescription

public void setDescription(java.lang.String theDescription)
Changes the value of the current node's description property.
Parameters:
theDescription - New description of the current node

getStepId

public int getStepId()
Gets the value of this step's stepId property.
Returns:
Step ID
See Also:
VWMapDefinition

getLocation

public java.awt.Point getLocation()
Gets the value of the location property associated with this step.
Returns:
Location of this step; null if there is value set for the location property of this VWMapNode object.

setLocation

public void setLocation(java.awt.Point theLocation)
Sets the value of the location property associated with this step.
Parameters:
theLocation - New location of this step

getSplitType

public int getSplitType()
Gets the step's split type.
Returns:
Integer value of the step's SplitType property.
See Also:
VWSplitType

setSplitType

public void setSplitType(int theSplitType)
                  throws VWException
Changes the value of this step's SplitType property.
Parameters:
theSplitType - New split type for this step definition
Throws:
VWException - Thrown if the split type is invalid
See Also:
VWSplitType.field_summary

getJoinType

public int getJoinType()
Gets the value of this step's JoinType property.
Returns:
An integer value that represents the join type of this step
See Also:
VWJoinType

setJoinType

public void setJoinType(int theJoinType)
                 throws VWException
Changes the value of this step's JoinType property.
Parameters:
theJoinType - New join type of this step
Throws:
VWException - Thrown if the join type is invalid
See Also:
VWJoinType

deleteRoute

public void deleteRoute(int theRouteId)
                 throws VWException
Deletes an outbound route from this step.
Parameters:
theRouteId - ID of the route to be deleted
Throws:
VWException - Thrown if the system does not find the specified route ID, or the ID does not originate with this step
See Also:
VWRouteDefinition

createRoute

public VWRouteDefinition createRoute(int theDestinationId)
                              throws VWException
Creates an outbound route for the current step. This step will be the implicit source step for the route.
Note
When you call getNextRoutes() after createRoute, by default this method returns routes in the order in which they were created. You may alter this order by calling the reorderRoutes method.
Parameters:
theDestinationId - ID of the destination step of the new route
Returns:
The newly created route
Throws:
VWException - Thrown if there is an error during route creation.
See Also:
VWRouteDefinition

getNextRoutes

public VWRouteDefinition[] getNextRoutes()
                                  throws VWException
Gets the definition of each outbound route associated with the current node.
Returns:
Array that contains the outbound route definitions for the current node at runtime, in the order in which the system evaluated the conditions associated with the routes.
Note
null is returned if there is no outbound route.
See Also:
VWRouteDefinition, createRoute(int), reorderRoutes(int[])

getRoute

public VWRouteDefinition getRoute(int theRouteId)
                           throws VWException
Gets the route definition object specified by the route ID parameter.
Parameters:
theRouteId - ID of the route for which the caller wants to retrieve a definition object
Returns:
Route definition object specified by the route ID parameter
See Also:
VWRouteDefinition

getPreviousRoutes

public VWRouteDefinition[] getPreviousRoutes()
                                      throws VWException
Gets the definition of each inbound route associated with this step.
Returns:
Array that contains the inbound route definitions for this step, returned in the order in which the system evaluated the conditions associated with the routes at runtime, or null if there is no inbound route.
See Also:
VWRouteDefinition, createRoute(int), reorderRoutes(int[])

getRouteFrom

public VWRouteDefinition getRouteFrom(int theSourceStepId)
                               throws VWException
Gets the inbound route from another step.
Returns:
Definition of the route from the step you specify, or null if there is no inbound route from the source step.
See Also:
VWRouteDefinition

getRouteTo

public VWRouteDefinition getRouteTo(int theDestinationStepId)
                             throws VWException
Gets the outbound route to another step.
Returns:
Definition of the route to the step you specify, or null if there is no outbound route
See Also:
VWRouteDefinition

reorderRoutes

public void reorderRoutes(int[] theRouteOrder)
                   throws VWException
Changes the order in which the system stores outbound routes in this map node. At runtime, the system evaluates conditions attached to outbound routes in the order in which it stores routes. This method allows the caller to change that order.

When the user calls the getNextRoutes() method, the routes are returned in the order in which they are stored, which, by default, is the order is the order in which they were created, unless the user calls this method to change that order.

Parameters:
theRouteOrder - Array of integers, which you set to contain one route ID integer for each route in this step. The order of the route IDs in the array is the new order for the outbound routes.

Use a route ID value only once in the array. Determine the number of routes in a step by calling the getNextRoutes method and checking the length of the returned array of routes.

Throws:
VWException - Thrown if the input parameter (theRouteOrder) that defines the order of routes is invalid. This could result from that parameter having the wrong number of elements or an inconsistent content.
See Also:
VWRouteDefinition, getNextRoutes(), createRoute(int)

getNodeType

public int getNodeType()
Returns the value of the map node type.
Returns:
The value of the node type, as defined in the VWNodeType class.
See Also:
VWNodeType

getRuleSets

public VWRuleSetDefinition[] getRuleSets(int ruleSetSelector)
                                  throws VWException
Retrieves the array of VWRuleSetDefinition objects for this step definition of the type, specified by the ruleSetSelector parameter.
Parameters:
ruleSetSelector - an int value which specifies which among the pre, post or the update rules are to be returned. This parameter must be one of the values shown in the field summary for this class.
Returns:
An array of VWRuleSetDefinitions for this step definition, or null if there are no rule sets associated with this step of the type specified by the ruleSetSelector parameter.
Throws:
VWException - Thrown if there is low-level array access error.

setRuleSets

public void setRuleSets(int ruleSetSelector,
                        VWRuleSetDefinition[] theRules)
                 throws VWException
Sets the VWRuleSetDefinitions for this step definition.
Parameters:
ruleSetSelector - an int value which specifies which among the pre, post or the update rules will be set by this call.
theRules - an array of the VWRuleSetDefinition objects for this step. The VWRuleSetDefinitions in the array must be references to VWRuleSetDefinition objects which exist in the workflow definition.
Throws:
VWException - Thrown if there is low-level array access error.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.