|
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
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.
VWMapDefinition
,
VWRouteDefinition
,
VWStepDefinition
,
VWCompoundStepDefinition
,
VWJoinType
,
VWSplitType
,
VWException
, Serialized FormMethod 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 |
public abstract void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
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.VWException
- Thrown if an error occurs during the validationpublic abstract void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
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 this nodeVWException
- Thrown if the name is null or invalidpublic java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- New description of this nodepublic int getStepId()
VWMapDefinition
public java.awt.Point getLocation()
Point
public void setLocation(java.awt.Point theLocation)
theLocation
- New location of this steppublic int getSplitType()
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. |
VWSplitType
public void setSplitType(int theSplitType) throws VWException
theSplitType
- New split type for this step definitionVWException
- Thrown if the split type is invalidVWSplitType
public int getJoinType()
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. |
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 if 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 creationreorderRoutes(int[])
,
VWRouteDefinition
public VWRouteDefinition[] getNextRoutes() throws VWException
VWRouteDefinition
,
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
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, one integer for each route in this stepVWException
- 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)VWRouteDefinition
,
getNextRoutes()
public int getNodeType()
VWNodeType
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |