|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWRouteDefinition
public final class 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 | |
---|---|
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. |
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)
Appends an XML string representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
validate(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 |
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 java.lang.String getCondition()
public void setCondition(java.lang.String theCondition)
theCondition
- The new value for the
condition property.public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- The new value for the description property.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 VWMapNode getSourceStep() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the source step cannot be found.public int getSourceStepId()
public void setSourceStepId(int theSourceStepId) throws VWException
theSourceStepId
- An 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
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the destination step cannot be found.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()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setName
public void setName(java.lang.String theName)
theName
- A String containing the new, user-defined route name.public boolean getRelease()
setRelease
public void setRelease(boolean theRelease)
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.
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.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
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 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 void validate(java.util.Vector EDefVector) throws VWException
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.
VWException
- Thrown if an error occurs during the validation.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |