|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMapDefinition
public final class VWMapDefinition
Use this class to access workflow steps and properties of the workflow map. A workflow map encapsulates the steps represented in the graphical representation of a workflow and is similar to a Process Engine instruction sheet.
VWStepDefinition
,
VWWorkflowDefinition
,
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. |
VWMapNode |
changeStepType(int theStepId)
Replaces in this map either a step (VWStepDefinition) with a compound step (VWCompoundStepDefinition), or a compound step with a step. |
VWCompoundStepDefinition |
createCompoundStep(java.lang.String theStepName)
Creates a compound step in this workflow map. |
VWStepDefinition |
createStep(java.lang.String theStepName)
Creates a step in this workflow map. |
VWTextAnnotationDefinition |
createTextAnnotation(java.lang.String theMessage)
Creates a new annotation for this map. |
void |
deleteStep(int theStepId)
Deletes a step from the workflow map. |
void |
deleteTextAnnotation(int theAnnotationId)
Deletes an annotation from this map. |
int |
getContainingStepId(int theStepId)
Gets the ID of the compound step that contains the instruction referenced by the specified ID. |
java.lang.String |
getDescription()
Gets the description of this map. |
int |
getMapId()
Gets this map ID. |
java.lang.String |
getName()
Gets the name of this map. |
VWMapNode |
getStartStep()
Gets the start step definition for this map. |
VWMapNode |
getStep(int theStepId)
Gets the step definition identified by the specified ID. |
VWMapNode[] |
getSteps()
Gets all of the steps contained in this map. |
VWTextAnnotationDefinition |
getTextAnnotation(int theAnnotationId)
Gets the annotation object in this map based on the specified ID. |
VWTextAnnotationDefinition[] |
getTextAnnotations()
Gets all of the annotations contained in this map. |
void |
normalize()
Ensures that the start step (the step having an ID of zero) is the first step in this map. |
IVWPastable[] |
paste(java.lang.String thePaste)
Pastes steps and text annotations into the workflow definition. |
VWMapNode[] |
pasteSteps(java.lang.String thePaste)
Deprecated. use the IVWPastable paste(String) method instead. This method was deprecated because we can now paste VWTextAnnotations in addition to the VWMapNodes. This method may fail if it is used to paste an XML string that contains anything other than steps (i.e. classes that inherit from VWMapNode). Pastes steps into the workflow definition. The step definitions are contained in an XML-formatted string. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this map. |
void |
setName(java.lang.String theName)
Sets the name for this map. |
java.lang.String |
toString()
Gets the String representation of this map name. |
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. |
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 VWStepDefinition createStep(java.lang.String theStepName) throws VWException
theStepName
- A String containing the name of the step to create.
VWException
- Thrown if the string specified in theStepName parameter is invalid.VWStepDefinition
public VWCompoundStepDefinition createCompoundStep(java.lang.String theStepName) throws VWException
theStepName
- A String containing the name of the step to create.
VWException
- Thrown if the string specified in 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 IVWPastable[] paste(java.lang.String thePaste) throws VWException
thePaste
- An XML-formatted String containing the
step definitions and text annotations to be pasted into the map.
VWException
- Thrown if the XML-formatted step definition cannot be pasted into into
the workflow definition.VWMapNode
public void deleteStep(int theStepId) throws VWException
theStepId
- An integer identifying the ID of the step to be deleted from the workflow map.
VWException
- Thrown if a VWStepDefinition object having the specified ID cannot be found.VWStepDefinition
public VWMapNode getStep(int theStepId) 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).
theStepId
- An integer identifying the step ID for the definition.
VWException
- Thrown if a VWStepDefinition object having the step
ID specified cannot be found.VWStepDefinition
public int getContainingStepId(int theStepId) throws VWException
theStepId
- An integer identifying the step ID of the contained instruction.
VWException
- Thrown if the specified ID does not identify any step or
instruction in this map.public VWMapNode getStartStep() 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).
The main workflow map, identified by its ID of zero (0), has a start step named "LaunchStep".
Note: A start step cannot be deleted and cannot be a destination of any route.
VWException
- Thrown if an error occurs while attempting to find the start step in this map (such as
when no start step exists in the map).VWStepDefinition
public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setDescription(java.lang.String theDescription)
theDescription
- A String containing the description of this map.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).
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name for this workflow map.
VWException
- Thrown the parameter is null or invalid.public java.lang.String toString()
toString
in class java.lang.Object
public VWMapNode changeStepType(int theStepId) throws VWException
Warning: Information specific to the step type will be lost (such as instructions in the VWCompoundStepDefinition object; or parameters, participants, responses and queue name in the VWStepDefinition object).
The following limitations apply:
For optimal performance, any active references to the pre-existing VWMapNode object should be cleared so that the object can be garbage-collected.
theStepId
- An integer containing the step ID of the step or compound step to be replaced.
VWException
- Thrown under these conditions:
VWMapNode
,
VWStepDefinition
,
VWCompoundStepDefinition
public VWMapNode[] getSteps() 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 an error occurs.public VWTextAnnotationDefinition[] getTextAnnotations() throws VWException
VWException
- Thrown if an error occurs.public void deleteTextAnnotation(int theAnnotationId) throws VWException
theAnnotationId
- An integer specifying the ID of the annotation to delete.
VWException
- Thrown if the annotation ID is invalid.public VWTextAnnotationDefinition getTextAnnotation(int theAnnotationId) throws VWException
theAnnotationId
- An integer specifying the annotation ID.
VWException
- Thrown if the specified ID is invalid.VWTextAnnotationDefinition
public VWTextAnnotationDefinition createTextAnnotation(java.lang.String theMessage) throws VWException
theMessage
- A String containing the message text for the annotation.
VWException
public void normalize() throws VWException
VWException
- Thrown if an error occurs.public int getMapId() throws VWException
Use map ID values in runtime situations to associate server instruction sheets with the corresponding VWMapDefinition objects. Log queries are another common situation for map ID use.
The reserved map IDs and their associated map names are as follows:
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 map ID is not found.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
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |