VWRouteDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWRouteDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWRouteDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VWAttributeInfo`	`getAttributeInfo()` Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
`java.lang.String`	`getCondition()` Gets the value contained in the condition property.
`java.lang.String`	`getDescription()` Returns the description property
`VWMapNode`	`getDestinationStep()` Gets the information contained 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.
`boolean`	`getRelease()` Indicates whether the release flag is set for this route.
`int`	`getRouteId()` Gets the value of the routeId property.
`VWMapNode`	`getSourceStep()` Gets the source node (step).
`int`	`getSourceStepId()` Gets the integer value of the stepId property for the step source.
`void`	`setAttributeInfo(VWAttributeInfo theAttributeInfo)` Sets a VWAttribute object containing attributes for this object.
`void`	`setCondition(java.lang.String theCondition)` Sets the condition property.
`void`	`setDescription(java.lang.String theDescription)` Sets the description 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 for this route.
`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)` Deprecated. Use `VWWorkflowDefinition.write(java.io.OutputStream)` or `VWWorkflowDefinition.writeToFile(String)`.
`void`	`toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)` Deprecated. Use `VWWorkflowCollectionDefinition.write(java.io.OutputStream)` or `VWWorkflowCollectionDefinition.writeToFile(String)`.
`void`	`validate(java.util.Vector EDefVector)` Deprecated. Use `VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)`

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 route condition property.
  - setCondition
```
public void setCondition(java.lang.String theCondition)
```
    Sets the condition property.
    
    Parameters:
    
    theCondition - The new value for the condition property.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description property
    
    Returns:
    
    the description property.
    
    Since:
    
    P8 4.5.0
  - setDescription
```
public void setDescription(java.lang.String theDescription)
```
    Sets the description property
    
    Parameters:
    
    theDescription - The new value for the description property.
    
    Since:
    
    P8 4.5.0
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Returns:
    
    A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    Since:
    
    P8 4.5.0
    
    See Also:
    
    VWRouteDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets a VWAttribute object containing attributes for this object.
    
    Parameters:
    
    theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    Since:
    
    P8 4.5.0
    
    See Also:
    
    VWRouteDefinition.getAttributeInfo()
  - getSourceStep
```
public VWMapNode getSourceStep()
                        throws VWException
```
    Gets the source node (step). If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A VWMapNode object for the source node. If a translation source exists, the translated node information is returned; otherwise, the authored information is returned.
    
    Throws:
    
    VWException - Thrown if the source step cannot be found.
  - getSourceStepId
```
public int getSourceStepId()
```
    Gets the integer value of the stepId property for the step source.
    
    Returns:
    
    An 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 - An 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 in the object that represents the step destination. If a translation source exists, the authored information is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A VWMapNode object that contains destination definition information for the step. If a translation source exists, the translated information is returned; otherwise, the authored information is returned.
    
    Throws:
    
    VWException - Thrown if the destination step cannot be found.
  - 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. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A String containing the translated name, if a translation source exists; otherwise, the authored name is returned.
    
    See Also:
    
    setName
  - 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 may contain spaces and punctuation. The name identifies the user-interface representation of the route.
    
    Parameters:
    
    theName - A String containing the new, user-defined route name.
  - getRelease
```
public boolean getRelease()
```
    Indicates whether the release flag is set for this route.
    
    Returns:
    
    A boolean value of true if the release flag is set; false otherwise.
    
    See Also:
    
    setRelease
  - setRelease
```
public void setRelease(boolean theRelease)
```
    Sets the value of the release flag for this route.
    Setting this flag indicates that a child work object of a split, passing through the route, is to notify its parent work object not to wait for it.
    
    This flag is normally set automatically by calling VWWorkflowDefinition.validate, with the fixUpSteps parameter set to true.
    
    Advanced users can use this method to control a workflow's runtime behavior. However, calling VWworkflowDefinition.validate can change the release flags set on any or all routes, including any that the user had previously set by calling this method.
    
    Parameters:
    
    theRelease - A boolean value of true sets the release flag, indicating that the parent work object does not need to wait for the current child work object; false clears (unsets) 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 indicating the route ID.
  - toString
```
public java.lang.String toString()
```
    Gets the string version of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the name (possibly null), and ID values for both the source and destination steps.
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowDefinition
  - toXPDL
```
public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
```
    Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).
    
    Appends an XPDL string representing this instance to the buffer specified.
    Warning: This XPDL string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    indentA - A String specifying the initial indentation for this XPDL section.
    
    theBuffer - A StringBuffer that will be appended with the XPDL content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowCollectionDefinition
  - validate
```
public void validate(java.util.Vector EDefVector)
              throws VWException
```
    Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)
    
    Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.
    
    Parameters:
    
    EDefVector - 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.
    
    Throws:
    
    VWException - Thrown if an error occurs during the validation.

Methods inherited from class java.lang.Object

getCondition

setCondition

getDescription

setDescription

getAttributeInfo

setAttributeInfo

getSourceStep

getSourceStepId

setSourceStepId

getDestinationStep

getDestinationStepId

setDestinationStepId

getName

setName

getRelease

setRelease

getRouteId

toString

toXML

toXPDL

validate