|
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.VWMapDefinition
Use this class to access workflow steps and properties of the Workflow Map. A Workflow Map encapsulates the steps of the graphical representation of a workflow and is similar to a Process system instruction sheet.
VWStepDefinition
,
VWWorkflowDefinition
, Serialized FormMethod Summary | |
VWMapNode |
changeStepType(int theStepId)
Replaces a VWStepDefinition with a VWCompoundStepDefinition or replaces a VWCompoundStepDefinition with a VWStepDefinition. |
VWCompoundStepDefinition |
createCompoundStep(java.lang.String theStepName)
Creates a compound step on the workflow map. |
VWStepDefinition |
createStep(java.lang.String theStepName)
Creates a step on the Workflow Map. |
void |
deleteStep(int theStepId)
Deletes a step from the Workflow Map, using an integer value for the step ID. |
java.lang.String |
getDescription()
Gets the description of the Workflow Map. |
int |
getMapId()
Retrieves the unique integer value of the work flow Map ID, identifying a map within the containing work flow. |
java.lang.String |
getName()
Gets the name of the Workflow Map. |
VWMapNode |
getStartStep()
Gets the start step definition for the current map. |
VWMapNode |
getStep(int theStepId)
Uses the integer value of a step ID on the current workflow map to get the associated step definition. |
VWMapNode[] |
getSteps()
Gets the steps contained in the VWMapDefinition. |
VWMapNode[] |
pasteSteps(java.lang.String thePaste)
Pastes steps into the workflow definition. |
void |
setDescription(java.lang.String theDescription)
Sets the description for the Workflow Map. |
void |
setName(java.lang.String theName)
Sets the name for the Workflow Map. |
java.lang.String |
toString()
Gets the string version of the Workflow Map name. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWMapDefinition object to the buffer specified by the input parameter. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public VWStepDefinition createStep(java.lang.String theStepName) throws VWException
theStepName
- The name of the step to
create.VWException
- The method throws
an exception if the string specified as the input
theStepName parameter is invalid.VWStepDefinition
public VWCompoundStepDefinition createCompoundStep(java.lang.String theStepName) throws VWException
theStepName
- The name of the step to
create.VWException
- Thrown if the string specified as the input
"theStepName" parameter is invalid.VWCompoundStepDefinition
public VWMapNode[] pasteSteps(java.lang.String thePaste) throws VWException
thePaste
- An XML-formatted string containing the
step definitions to be pasted into the map.VWException
- Thrown if it cannot paste the
XML-formatted step definition into the workflow definition.VWMapNode
public void deleteStep(int theStepId) throws VWException
theStepId
- An integer value for the step ID to be deleted
from the Workflow Map.VWException
- The method throws an
exception if no step with an ID matching the value input in
the theStepId parameter exists.VWStepDefinition
public VWMapNode getStep(int theStepId) throws VWException
theStepId
- An integer value containing the step ID for
step the definition.VWException
- The method throws an
exception if a VWStepDefinition object matching the step
ID value input to the theStepId parameter does not exist.VWStepDefinition
public VWMapNode getStartStep() throws VWException
VWException
- Thrown if an error occurs while searching
the Workflow Map for the start step; for instance, if no start
step exists in the map.VWStepDefinition
public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- The new
description of the Workflow Map object.public java.lang.String getName()
public void setName(java.lang.String theName) throws VWException
theName
- The new name for the
Workflow Map.VWException
- The method throws
an exception if theName parameter is empty or null.public java.lang.String toString()
toString
in class java.lang.Object
public VWMapNode changeStepType(int theStepId) throws VWException
LIMITATION:
The type of the launch step cannot be changed. Information in the VWMapNode base class, like the step id, location, and route information, will be retained.
WARNING:
Information specific to the step type, like instructions in a VWCompoundStepDefinition or parameters, participants, responses and queue name in a VWStepDefinition, will be lost.
Note that this method will create a new VWMapNode and the old VWMapNode will be deleted from the map.
PERFORMANCE SUGGESTION:
Any active references to the old VWMapNode should be cleared so that the object can be garbage-collected.
theStepId
- an integer containing the stepId of the step to
be convertedVWException
- thrown if an error occurs; for example,
if theStepId parameter is not a valid step id.VWMapNode
,
VWStepDefinition
,
VWCompoundStepDefinition
public VWMapNode[] getSteps() throws VWException
public int getMapId() throws VWException
Use Map ID values in run time situations to associate server instruction sheets with the corresponding VWMapDefinition objects. Log queries are another common situation for Map ID use.
Reserved Map IDs and their associated System map names are shown below:
Map Name | Map ID |
Workflow | -2 |
Terminate | -3 |
Malfunction | -4 |
QueueAssertionViolation | -5 |
Recovery | -6 |
Tracker | -7 |
Other non-inherited maps are assigned IDs in order of creation, begining with 0 and incrementing by 1.
VWException
- Thrown if this method cannot
get the integer value of the work flow Map IDpublic void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |