Process Class Relationships

filenet.vw.api
Class VWRouteDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWRouteDefinition
All Implemented Interfaces:
java.io.Serializable

public final class VWRouteDefinition
extends java.lang.Object
implements java.io.Serializable

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.

Since:
VWWS3.10
See Also:
VWException, VWMapNode, Serialized Form

Method 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

getCondition

public java.lang.String getCondition()
Gets the value contained in the condition property.
Returns:
The information stored in the the route condition property.

setCondition

public void setCondition(java.lang.String theCondition)
Sets the condition property.
Parameters:
theCondition - The new value for the condition property.

getSourceStep

public VWMapNode getSourceStep()
                        throws VWException
Gets an object containing the source node.
Returns:
An object containing the source node.
Throws:
VWException - Thrown if the system cannot find the source step.

getSourceStepId

public int getSourceStepId()
Gets the integer value of the stepId property for the step source.
Returns:
A integer value that represents the contents if the stepId property of the step source.

setSourceStepId

public void setSourceStepId(int theSourceStepId)
                     throws VWException
Sets the integer value of the stepId property for the step source.
Parameters:
theSourceStepId - A integer value to be used as the new ID of source step.
Throws:
VWException - Thrown if the system cannot find the source step.

getDestinationStep

public VWMapNode getDestinationStep()
                             throws VWException
Gets the information contained by the in the object that represents the step destination.
Returns:
An object that contains destination definition information for the step.
Throws:
VWException - Thrown if the system cannot find the destination step.

getDestinationStepId

public int getDestinationStepId()
Gets the integer value of the stepId property for the step destination.
Returns:
An integer value, retrieved from the stepId property, that indicates the step ID for the step destination.

setDestinationStepId

public void setDestinationStepId(int theDestinationStepId)
                          throws VWException
Sets the integer value of the stepId property for the step destination.
Parameters:
theDestinationStepId - An integer value for the ID of the step destination.
Throws:
VWException - Thrown if the system cannot find the destination step.

getName

public java.lang.String getName()
Gets the route name from the name property.
Returns:
The route name.

setName

public void setName(java.lang.String theName)
Sets the route name by modifying the name property. The route name need not be unique, and the name may contain spaces and punctuation. The name identifies the user-interface representation of the route.
Parameters:
theName - The new, user-defined route name.

getRelease

public boolean getRelease()
Gets the value in the release flag.
Returns:
A Boolean value. This method returns the current state of the release flag.

setRelease

public void setRelease(boolean theRelease)
Sets the value of the release flag. Specify true so that a child work object of a split, passing through the route, will notify its parent work object not to wait for that child work object. This flag is normally set automatically by calling VWWorkflowDefinition.validate, with the fixUpSteps parameter set equal to true. Advanced users may use the setRelease method to control the run-time behavior of the workflow, but note that calling VWworkflowDefinition.validate may change the release flags on any or all routes, including any that the user had previously set by calling the setRelease method. The release flag may be unset by inputting false in theRelease parameter of setRelease.
Parameters:
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.
See Also:
VWWorkflowDefinition.validate(filenet.vw.api.VWSession, boolean)

getRouteId

public int getRouteId()
Gets the value of the routeId property.
Returns:
An integer value of that indicates the route ID.

toString

public java.lang.String toString()
Gets the string version of the object.
Overrides:
toString in class java.lang.Object
Returns:
The name, which might be null, and the ID values for the source and destination steps.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWRouteDefinition 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

validate

public void validate(java.util.Vector EDefVector)
              throws VWException
Validate this VWRouteDefinition object.
Parameters:
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

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.