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

Abstract base class which encapsulates the routing, location and other properties related to the behaviour of steps in a map (as distinct from properties of the step itself such as parameters, participants etc.,). This class will be extended to produce the different types of steps which live in a map (step definitions, compound steps etc.,). Classes which extend this class are VWStepDefinition and VWCompoundStepDefinition.

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

Method Summary
 VWRouteDefinition createRoute(int theDestinationId)
          Create an outbound route for this step.
 void deleteRoute(int theRouteId)
          Delete an outbound route from this step.
 java.lang.String getDescription()
          Get the value of this nodes's description property.
 int getJoinType()
          Get the value of this step's joinType property.
 java.awt.Point getLocation()
          Get the value of the location property associated with this step.
 java.lang.String getName()
          Get the value of this node's name property.
 VWRouteDefinition[] getNextRoutes()
          Get the definition of each outbound route associated with this node.
 int getNodeType()
           
 VWRouteDefinition[] getPreviousRoutes()
          Get the definition of each inbound route associated with this step.
 VWRouteDefinition getRoute(int theRouteId)
          Get the route definition object identified by the route ID parameter.
 VWRouteDefinition getRouteFrom(int theSourceStepId)
          Get the inbound route from another step.
 VWRouteDefinition getRouteTo(int theDestinationStepId)
          Get the outbound route to another step.
 int getSplitType()
          Get the step's split type.
 int getStepId()
          Get the value of this step's stepId property.
 void reorderRoutes(int[] theRouteOrder)
          Change the order in which the system stores outbound routes in this map node.
 void setDescription(java.lang.String theDescription)
          Change the value of this nodes's description property.
 void setJoinType(int theJoinType)
          Change the value of this step's joinType property.
 void setLocation(java.awt.Point theLocation)
          Set the value of the location property associated with this step.
 void setName(java.lang.String theName)
          Change the value of this node's name property.
 void setSplitType(int theSplitType)
          Change the value in this step's splitType property.
abstract  java.lang.String toString()
          Get a string representation of this map node object.
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)
          Validate this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

validate

public abstract void validate(VWSession theSession,
                              java.util.Vector EDefVector)
                       throws VWException
Validate this object.
Parameters:
theSession - The session object if logged on. This object is needed for various parts of the validation process. The object may be null, but areas of validation that require a logon will not be validated.
EDefVector - a Vector to which will be added any VWValidationErrors found during this call, the Vector may already contain some validation errors errors from previous calls to validate on other objects.
Returns:
void, but the EDefVector will be updated to contain any validation errors found during this call.
Throws:
VWException - Thrown if an 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 that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

toString

public abstract java.lang.String toString()
Get a string representation of this map node object. This method is typically used only for debugging purposes, to allow the caller to "print" the node (the subclass implementing this method will probably just return the name of the node, but it may vary with the implementation).
Overrides:
toString in class java.lang.Object

getName

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

setName

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

getDescription

public java.lang.String getDescription()
Get the value of this nodes's description property.
Returns:
Description of this node
Null if the description is null

setDescription

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

getStepId

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

getLocation

public java.awt.Point getLocation()
Get the value of the location property associated with this step.
Returns:
Location of this step
Null if there is no location
See Also:
Point

setLocation

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

getSplitType

public int getSplitType()
Get the step's split type.
Returns:
Integer value of the step's splitType property, as follows:

Value Split type This means that...
1 SPLIT_TYPE_AND Work flows along parallel routes.
2 SPLIT_TYPE_OR Workflow branches to one of various routes, depending on a condition.
3 SPLIT_TYPE_NONE There is no split.
See Also:
VWSplitType

setSplitType

public void setSplitType(int theSplitType)
                  throws VWException
Change the value in 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

getJoinType

public int getJoinType()
Get the value of this step's joinType property.
Returns:
An integer value that represents the join type of this step, as follows:
Value Join type This means that...
1 JOIN_TYPE_AND Work flows along parallel routes (complements an AND_SPLIT).
2 JOIN_TYPE_OR Work flows along one of various routes (complements an OR_SPLIT).
3 JOIN_TYPE_NONE There is no join.
See Also:
VWJoinType

setJoinType

public void setJoinType(int theJoinType)
                 throws VWException
Change 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
Delete 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 if the ID does not originate with this step
See Also:
VWRouteDefinition

createRoute

public VWRouteDefinition createRoute(int theDestinationId)
                              throws VWException
Create an outbound route for this step. The source step for the route is implicitly this step. When the user calls the getNextRoutes method, the system stores and returns routes in the order in which you created them, unless the user calls the reorderRoutes method.
Parameters:
theDestinationId - ID of the destination step of the new route
Returns:
Newly created route
Throws:
VWException - Thrown if there is an error during route creation
See Also:
reorderRoutes(int[]), VWRouteDefinition

getNextRoutes

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

getRoute

public VWRouteDefinition getRoute(int theRouteId)
                           throws VWException
Get the route definition object identified 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 identified by the route ID parameter
See Also:
VWRouteDefinition

getPreviousRoutes

public VWRouteDefinition[] getPreviousRoutes()
                                      throws VWException
Get 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
Null if there is no inbound route
See Also:
VWRouteDefinition

getRouteFrom

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

getRouteTo

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

reorderRoutes

public void reorderRoutes(int[] theRouteOrder)
                   throws VWException
Change 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, one integer for each route in this step
The number of elements in the array must be the same as the number of routes in the step. Each element of the array is the ID of an outgoing route of this step. The order of the route IDs in the array is the order in which the system evaluates route conditions after the routes are re-ordered. Use a 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. This array contains the outbound route objects of this step in their current order.
Throws:
VWException - Thrown if the array of integers parameter that defines the order of routes is invalid (if it has the wrong number of elements or inconsistent content)
See Also:
VWRouteDefinition, getNextRoutes()

getNodeType

public int getNodeType()
See Also:
VWNodeType

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.