|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWMapNode
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.
VWMapDefinition
,
VWRouteDefinition
,
VWStepDefinition
,
VWCompoundStepDefinition
,
VWJoinType
,
VWSplitType
,
VWException
, Serialized FormField 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 |
public static final int PRE_RULESETS
getRuleSets(int)
and setRuleSets(int, VWRuleSetDefinition [])
.public static final int UPDATE_RULESETS
getRuleSets(int)
and setRuleSets(int, VWRuleSetDefinition [])
.public static final int POST_RULESETS
getRuleSets(int)
and setRuleSets(int, VWRuleSetDefinition [])
.Method Detail |
public abstract void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
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.
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.VWException
- Thrown if a system error occurs during
the validation.public abstract void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A String buffer to which this method will append
XML content.VWException
- VWXMLUtil
public abstract java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
public void setName(java.lang.String theName) throws VWException
theName
- New name of the current nodeVWException
- Thrown if the name is null or invalidpublic java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- New description of the current nodepublic int getStepId()
VWMapDefinition
public java.awt.Point getLocation()
public void setLocation(java.awt.Point theLocation)
theLocation
- New location of this steppublic int getSplitType()
VWSplitType
public void setSplitType(int theSplitType) throws VWException
theSplitType
- New split type for this step definitionVWException
- Thrown if the split type is invalidpublic int getJoinType()
VWJoinType
public void setJoinType(int theJoinType) throws VWException
theJoinType
- New join type of this stepVWException
- Thrown if the join type is invalidVWJoinType
public void deleteRoute(int theRouteId) throws VWException
theRouteId
- ID of the route to be deletedVWException
- Thrown if the system does not find the
specified route ID, or the ID does not originate with this stepVWRouteDefinition
public VWRouteDefinition createRoute(int theDestinationId) throws VWException
theDestinationId
- ID of the destination step of the new routeVWException
- Thrown if there is an error during route
creation.VWRouteDefinition
public VWRouteDefinition[] getNextRoutes() throws VWException
VWRouteDefinition
,
createRoute(int)
,
reorderRoutes(int[])
public VWRouteDefinition getRoute(int theRouteId) throws VWException
theRouteId
- ID of the route for which the caller wants to retrieve
a definition objectVWRouteDefinition
public VWRouteDefinition[] getPreviousRoutes() throws VWException
VWRouteDefinition
,
createRoute(int)
,
reorderRoutes(int[])
public VWRouteDefinition getRouteFrom(int theSourceStepId) throws VWException
VWRouteDefinition
public VWRouteDefinition getRouteTo(int theDestinationStepId) throws VWException
VWRouteDefinition
public void reorderRoutes(int[] theRouteOrder) throws VWException
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.
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.
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.VWRouteDefinition
,
getNextRoutes()
,
createRoute(int)
public int getNodeType()
VWNodeType
public VWRuleSetDefinition[] getRuleSets(int ruleSetSelector) throws VWException
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.VWException
- Thrown if there is low-level array access
error.public void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules) throws VWException
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.VWException
- Thrown if there is low-level array access
error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |