|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMapNode
public abstract class VWMapNode
An abstract base class that encapsulates the routing, location, and other properties related to the steps of a map. Step properties (such as parameters or participants) that do not define the step relative to a map are not defined for this class.
Classes that extend VWMapNode to produce the different types of steps a map contains include the step definition classes VWStepDefinition and VWCompoundStepDefinition.
VWMapDefinition
,
VWRouteDefinition
,
VWStepDefinition
,
VWCompoundStepDefinition
,
VWJoinType
,
VWSplitType
,
VWException
,
Serialized FormField Summary | |
---|---|
static int |
POST_RULESETS
Indicates a type of ruleset that is executed the work object is dispatched. |
static int |
PRE_RULESETS
Indicates a type of ruleset that is executed before a user gets the work object. |
static int |
UPDATE_RULESETS
Indicates a type of ruleset that is executed when the work object is saved. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
VWRouteDefinition |
createRoute(int theDestinationId)
Creates an outbound route for the current step. |
void |
deleteRoute(int theRouteId)
Deletes an outbound route from this step. |
VWAttributeInfo |
getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
java.lang.String |
getDescription()
Gets the value of the current node's description property. |
java.lang.String |
getDocumentation()
Gets the value of the current node's documentation 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 for the route ID specified. |
VWRouteDefinition |
getRouteFrom(int theSourceStepId)
Gets the inbound route from another step. |
VWRouteDefinition |
getRouteTo(int theDestinationStepId)
Gets the outbound route to another step. |
java.lang.String[] |
getRuleSetNames(int ruleSetSelector)
Retrieves the names of the rulesets for this step definition, based on the type specified by the ruleSetSelector parameter. |
VWRuleSetDefinition[] |
getRuleSets(int ruleSetSelector)
Deprecated. Use getRuleSetNames() instead. With the inheritence of rulesets from parent workflows, there is no guarantee that this method will return a correct VWRuleSetDefinition object for all the rules on a step, although the name (returned by VWRuleSetDefinition.getValue() )
will be acurate. For backward compatibility, this method will continue to return
an array of VWRuleSetDefinition objects, but only the name will be guaranteed to be
correct. |
VWSession |
getSession()
Get the session associated with this mapnode definition. |
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 |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
setDescription(java.lang.String theDescription)
Sets the value of the current node's description property. |
void |
setDocumentation(java.lang.String theDocumentation)
Sets the value of the current node's documentation property. |
void |
setJoinType(int theJoinType)
Sets 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)
Sets the value of the current node's name property. |
void |
setRuleSets(int ruleSetSelector,
java.lang.String[] theStringRules)
Sets the rulesets for this step definition. |
void |
setRuleSets(int ruleSetSelector,
VWRuleSetDefinition[] theRules)
Deprecated. Use setRuleSets() instead. With the inheritence of rulesets from parent workflows, rules on a step should be set using an array of strings (the ruleset names), instead of an array of ruleset definitions. For backward compatibility this method will continue to accept an array of VWRuleSetDefinition objects, but only the name (returned by VWRuleSetDefinition.getValue() ) will be used. |
void |
setSplitType(int theSplitType)
Sets the value of this step's SplitType property. |
abstract java.lang.String |
toString()
Returns 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 representing this instance to the buffer specified. |
abstract void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string that represents this instance to the buffer specified. |
abstract void |
validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector 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 static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public abstract void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.EDefHandler
- A Vector to which will be added a VWValidationError object for each validation
error found. This can be null; in this case, a new Vector is used.
Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
VWException
- Thrown if an error occurs during the validation.public abstract void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public abstract void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.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 node
VWException
- 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 void setDocumentation(java.lang.String theDocumentation)
theDocumentation
- A String containing the documentation of the current node.public java.lang.String getDocumentation()
public 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 definition
VWException
- Thrown if the split type is invalidpublic int getJoinType()
VWJoinType
public void setJoinType(int theJoinType) throws VWException
theJoinType
- New join type of this step
VWException
- Thrown if the join type is invalidVWJoinType
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format.
VWException
getAttributeInfo()
public void deleteRoute(int theRouteId) throws VWException
theRouteId
- ID of the route to be deleted
VWException
- 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
Note: When you call getNextRoutes()
after createRoute, by default
this method returns routes in the order in which they were created. You can alter
this order by calling reorderRoutes(int[])
.
theDestinationId
- An int indicating the ID of the destination step of the new route.
VWException
- Thrown if there is an error during route creation.VWRouteDefinition
public VWRouteDefinition[] getNextRoutes() throws VWException
Note: Null is returned if there is no outbound route defined.
VWException
VWRouteDefinition
,
createRoute(int)
,
reorderRoutes(int[])
public VWRouteDefinition getRoute(int theRouteId) throws VWException
theRouteId
- An int indicating the ID of the route definition.
VWException
VWRouteDefinition
public VWRouteDefinition[] getPreviousRoutes() throws VWException
VWException
VWRouteDefinition
,
createRoute(int)
,
reorderRoutes(int[])
public VWRouteDefinition getRouteFrom(int theSourceStepId) throws VWException
theSourceStepId
-
VWException
VWRouteDefinition
public VWRouteDefinition getRouteTo(int theDestinationStepId) throws VWException
theDestinationStepId
-
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
VWRuleSetDefinition.getValue()
)
will be acurate. For backward compatibility, this method will continue to return
an array of VWRuleSetDefinition objects, but only the name will be guaranteed to be
correct.
VWException
public java.lang.String[] getRuleSetNames(int ruleSetSelector) throws VWException
ruleSetSelector
- An int value specifying one of the following:
PRE_RULESETS
= 0 (a ruleset executed before a user gets the work object)UPDATE_RULESETS
= 1 (a ruleset executed when the work object is saved)POST_RULESETS
= 2 (a ruleset executed when the work object is dispatched)VWException
- Thrown if there is a low-level array access
error.public void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules) throws VWException
VWRuleSetDefinition.getValue()
) will be used.
VWException
public void setRuleSets(int ruleSetSelector, java.lang.String[] theStringRules) throws VWException
ruleSetSelector
- An int value specifying one of the following:
PRE_RULESETS
= 0 (a ruleset executed before a user gets the work object)UPDATE_RULESETS
= 1 (a ruleset executed when the work object is saved)POST_RULESETS
= 2 (a ruleset executed when the work object is dispatched)theStringRules
- A String array of the ruleset names for this step.
VWException
- Thrown if an error occurs.public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |