|
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.VWRouteDefinition
Use this class to access an object that represents the workflow authoring-time definition of a route. A workflow graph displays a route as an arc between steps. A route has a source step, destination step, name, and condition.
VWException
,
VWMapNode
, Serialized FormMethod Summary | |
java.lang.String |
getCondition()
Gets the value contained in the condition property. |
VWMapNode |
getDestinationStep()
Gets the information contained by the in the object that represents the step destination. |
int |
getDestinationStepId()
Gets the integer value of the stepId property for the step destination. |
java.lang.String |
getName()
Gets the route name from the name property. |
boolean |
getRelease()
Gets the value in the release flag. |
int |
getRouteId()
Gets the value of the routeId property. |
VWMapNode |
getSourceStep()
Gets an object containing the source node. |
int |
getSourceStepId()
Gets the integer value of the stepId property for the step source. |
void |
setCondition(java.lang.String theCondition)
Sets the condition property. |
void |
setDestinationStepId(int theDestinationStepId)
Sets the integer value of the stepId property for the step destination. |
void |
setName(java.lang.String theName)
Sets the route name by modifying the name property. |
void |
setRelease(boolean theRelease)
Sets the value of the release flag. |
void |
setSourceStepId(int theSourceStepId)
Sets the integer value of the stepId property for the step source. |
java.lang.String |
toString()
Gets the string version of the object. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWRouteDefinition object to the buffer specified by the input parameter. |
void |
validate(java.util.Vector EDefVector)
Validate this VWRouteDefinition object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String getCondition()
public void setCondition(java.lang.String theCondition)
theCondition
- The new value for the
condition property.public VWMapNode getSourceStep() throws VWException
VWException
- Thrown if the
system cannot find the source step.public int getSourceStepId()
public void setSourceStepId(int theSourceStepId) throws VWException
theSourceStepId
- A integer value to be used as the new
ID of source step.VWException
- Thrown if the
system cannot find the source step.public VWMapNode getDestinationStep() throws VWException
VWException
- Thrown if the
system cannot find the destination step.public int getDestinationStepId()
public void setDestinationStepId(int theDestinationStepId) throws VWException
theDestinationStepId
- An integer value for the ID of the
step destination.VWException
- Thrown if the
system cannot find the destination step.public java.lang.String getName()
public void setName(java.lang.String theName)
theName
- The new, user-defined route
name.public boolean getRelease()
public void setRelease(boolean theRelease)
theRelease
- A Boolean value. Set the this parameter to
set the release flag so the parent work object does not
need to wait for the current child work object; set this
parameter to false to unset the release flag.VWWorkflowDefinition.validate(filenet.vw.api.VWSession, boolean)
public int getRouteId()
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public void validate(java.util.Vector EDefVector) throws VWException
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 validation
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |