|
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.VWMapNode | +--filenet.vw.api.VWStepDefinition
Use this class to access a step definition object. Once you have a VWStepDefinition object you can create, delete, or modify property values for the step. A workflow map contains steps, each of which represents a logical unit of work in a process and has an ID that is unique on the map.
The step definition, within the context of the workflow, includes the following:
VWRouteDefinition
,
VWParameterDefinition
,
VWMapDefinition
,
VWMapNode
,
VWJoinType
,
VWSplitType
,
VWException
, Serialized FormField Summary | |
static int |
LVALUE
Integer value of 0: this constant can be used to subscript into the pre or post assignment arrays. |
static int |
RVALUE
Integer value of 1: this constant can be used to subscript into the pre or post assignment arrays. |
Method Summary | |
VWParameterDefinition |
createParameter(java.lang.String theName,
int theMode,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter definition with input name, direction, value, and type information. |
void |
deleteParameter(java.lang.String theName)
Deletes a parameter definition from the set of parameter definitions stored in this step. |
VWAttributeInfo |
getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
boolean |
getCanReassign()
Determines whether the user can reassign this step. |
boolean |
getCanViewStatus()
Determines whether or not the user can view the status of the current step. |
long |
getDeadline()
Gets the deadline property value for the step. |
java.lang.String |
getOperationName()
Gets the name of the Operation associated with this step. |
java.lang.String[] |
getOperationParameters()
Gets the array of Strings containing the parameter expressions for the Operation associated with this step. |
VWParameterDefinition |
getParameterDefinition(java.lang.String theName)
Gets a parameter definition from the set of parameter definitions stored in this step definition. |
VWParameterDefinition[] |
getParameterDefinitions()
Gets all parameter definitions stored in the step definition. |
VWParticipant[] |
getParticipants()
Gets the participants property value for the step. |
java.lang.String[][] |
getPostAssignments()
Gets the postAssignments property value for the step, which defines field values to be set after the step processes. |
java.lang.String |
getPostMilestone()
Gets the value of this step's post-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step finishes execution. |
java.lang.String[][] |
getPreAssignments()
Gets the preAssignments property value for the step, which defines field values to be set before the step processes. |
java.lang.String |
getPreMilestone()
Gets the value of this step's pre-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step executes. |
java.lang.String |
getQueueName()
Gets the name of the queue associated with this step. |
long |
getReminder()
Gets the value of this step's reminder property. |
java.lang.String |
getRequestedInterface()
Gets the requested interface of the step (usually a step processor name associated with the top level UI). |
java.lang.String[] |
getResponses()
Gets the responses to this step. |
void |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
setCanReassign(boolean theFlag)
Sets the canReassign property of the step. |
void |
setCanViewStatus(boolean theFlag)
Sets the step's canViewStatus property to indicate whether the user can view the status of this step. |
void |
setDeadline(long theDeadline)
Sets the deadline of this step. |
void |
setOperationName(java.lang.String theName)
Sets (or associates) an Operation with the current step. |
void |
setOperationParameters(java.lang.String[] theParams)
Sets an array of Strings containing the parameter expressions for the Operation associated with this step. |
void |
setParticipants(VWParticipant[] theParticipants)
Sets the participants property value for the step. |
void |
setPostAssignments(java.lang.String[][] thePostAssignments)
Sets the PostAssignments property value for the step, which defines field values to be set after the step processes. |
void |
setPostMilestone(java.lang.String mileStoneName)
Sets the value of this step's post-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step finishes execution. |
void |
setPreAssignments(java.lang.String[][] thePreAssignments)
Sets the PreAssignments property value for the step, which defines field values to be set before the step processes. |
void |
setPreMilestone(java.lang.String mileStoneName)
Sets the value of this step's pre-milestone property, which is the name of a milestone in this workflow which is "reached" just before this step begins execution. |
void |
setQueueName(java.lang.String theName)
Sets (or associates) a queue with the current step. |
void |
setReminder(long theReminder)
Sets the reminder value for the step. |
void |
setRequestedInterface(java.lang.String theInterface)
Requests an interface for the step (usually a a step processor name associated with the top level UI). |
void |
setResponses(java.lang.String[] theResponses)
Sets the responses to this step. |
java.lang.String |
toString()
Gets the name of the step definition object. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWStepDefinition object to the buffer specified by the input parameter. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector)
Validate this VWStepDefinition object. |
Methods inherited from class filenet.vw.api.VWMapNode |
createRoute, deleteRoute, getDescription, getJoinType, getLocation, getName, getNextRoutes, getNodeType, getPreviousRoutes, getRoute, getRouteFrom, getRouteTo, getSplitType, getStepId, reorderRoutes, setDescription, setJoinType, setLocation, setName, setSplitType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int LVALUE
public static final int RVALUE
Method Detail |
public VWParameterDefinition createParameter(java.lang.String theName, int theMode, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
theName
- The name of the parameter definition.
theMode
- An integer value specifying the mode of the
parameter. Valid modes
are MODE_TYPE_IN,
MODE_TYPE_OUT, and MODE_TYPE_IN_OUT.
theValue
- The value of the parameter definition.
theType
- An integer value specifying the field type
that applies to the value expression.
theIsArray
- A Boolean value. Specify true if you expect
the value expression to evaluate to an array; otherwise, specify
false.VWException
- Triggers include the following:
VWParameterDefinition
,
VWModeType
public void deleteParameter(java.lang.String theName) throws VWException
theName
- The name of the parameter
definition to be deleted.VWException
- The method throws an exception if it cannot
delete a parameter definition from the set of parameter
definitions stored in this step.VWParameterDefinition
public VWParameterDefinition getParameterDefinition(java.lang.String theName) throws VWException
getParameterDefinition
in interface filenet.vw.api.IVWHasParameterDefs
theName
- The name of the parameter
for which you seek the definition.VWParameterDefinition
public VWParameterDefinition[] getParameterDefinitions() throws VWException
VWParameterDefinition
public boolean getCanReassign()
public void setCanReassign(boolean theFlag)
theFlag
- A Boolean value. Specify true to allow the user
to reassign the current step; specify false to deny the user
the ability to reassign the step.public boolean getCanViewStatus()
theFlag
- A Boolean value. Specify true to allow the user
to view the status of the step; specify false to deny the user
the ability to view the status on the current step.public void setCanViewStatus(boolean theFlag)
theFlag
- A Boolean value. Specify true to allow the user
to view the status of the step; specify false to deny the
ability to view the status on the current step.public java.lang.String toString()
toString
in class VWMapNode
public VWParticipant[] getParticipants()
public void setParticipants(VWParticipant[] theParticipants)
theParticipants
- An array of VWParticipant objects that
represent the name of the set of participants to be associated
with the step.public java.lang.String getQueueName()
public void setQueueName(java.lang.String theName)
theName
- The name of the queue with
which you wish to associate the step.public java.lang.String getOperationName()
public void setOperationName(java.lang.String theName)
theName
- The name of the Operation with
which you wish to associate the step.public java.lang.String[] getOperationParameters()
public void setOperationParameters(java.lang.String[] theParams)
theParams
- A string array containing the parameters for the Operation
associated with the step.public java.lang.String getRequestedInterface()
public void setRequestedInterface(java.lang.String theInterface)
theInterface
- The new requested
interface (value of the requestedInterface property) of the
step.public java.lang.String[] getResponses()
public void setResponses(java.lang.String[] theResponses)
theResponses
- An array of strings containing the
responses to place in the responses property of the step.public long getDeadline()
public void setDeadline(long theDeadline) throws VWException
theDeadline
- A number specifying the dead line period,
in minutes.VWException
- The method throws an exception if the
theDeadline parameter contains a negative value.public long getReminder()
public java.lang.String getPostMilestone()
public void setPostMilestone(java.lang.String mileStoneName) throws VWException
mileStoneName
- a String containing the name of a milestone
in this workflow
which is "reached" just after this step finishes execution,
after any post-assignments are carried out. May be null,
which clears the post-milestone.VWException
- Thrown if the milestone name is invalid.public void setPreMilestone(java.lang.String mileStoneName) throws VWException
mileStoneName
- A String containing the name of a milestone
in this workflow
which is "reached" just before this step begins execution,
after any pre-assignments are carried out. May be null,
which clears the pre milestone.VWException
- Thrown if the milestone name is invalidpublic java.lang.String getPreMilestone()
public void setReminder(long theReminder) throws VWException
theReminder
- A number specifying the reminder period, in
minutes.VWException
- The method throws an exception if
theReminder parameter contains a negative value.public java.lang.String[][] getPreAssignments()
setPreAssignments(java.lang.String[][])
method.LVALUE
,
RVALUE
,
setPostAssignments(java.lang.String[][])
,
getPostAssignments()
,
setPreAssignments(java.lang.String[][])
public void setPreAssignments(java.lang.String[][] thePreAssignments) throws VWException
thePostAssignments
- A two-dimensional array of Strings that
contains pairs of left values and right values of assignment
operations which will be performed when this instruction
executes. The number of "rows" in the array (the first dimension)
is the number of assignment operations to be executed when the
instruction runs.
The first "column" of this array comprises the left-side values of a set of assignment operations. Each string is a field name which may be subscripted (myField or myArrayField[3], for example).
The second "column" of this array comprises the right-side values of a set of assignment operations. Each of these strings can be any valid expression recognized by the server (a literal constant like the string "hello" or the number 75, a field name, an arithmetic expression, a boolean expression or a function call).
VWException
- Thrown if thePreAssignments array is not properly
dimensioned, or if any elements in the array are null.LVALUE
,
RVALUE
,
setPostAssignments(java.lang.String[][])
,
getPostAssignments()
,
getPreAssignments()
public java.lang.String[][] getPostAssignments()
setPreAssignments(java.lang.String[][])
method.LVALUE
,
RVALUE
,
setPreAssignments(java.lang.String[][])
,
getPreAssignments()
,
setPreAssignments(java.lang.String[][])
public void setPostAssignments(java.lang.String[][] thePostAssignments) throws VWException
thePostAssignments
- A two-dimensional array of Strings that
contains pairs of left values and right values of assignment
operations which will be performed when this instruction
executes. The number of "rows" in the array (the first dimension)
is the number of assignment operations to be executed when the
instruction runs.
The first "column" of this array comprises the left-side values of a set of assignment operations. Each string is a field name which may be subscripted (myField or myArrayField[3], for example).
The second "column" of this array comprises the right-side values of a set of assignment operations. Each of these strings can be any valid expression recognized by the server (a literal constant like the string "hello" or the number 75, a field name, an arithmetic expression, a boolean expression or a function call).
VWException
- Thrown if thePreAssignments array is not
properly dimensioned, or if any elements in the array are null.LVALUE
,
RVALUE
,
setPreAssignments(java.lang.String[][])
,
getPreAssignments()
,
getPostAssignments()
public VWAttributeInfo getAttributeInfo() throws 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 void toXML(java.lang.StringBuffer theBuffer) throws VWException
toXML
in class VWMapNode
theBuffer
- A string buffer that this method will append with
XML content.VWException
- for example if the input buffer is null.
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
validate
in class VWMapNode
theSession
- The session object if logged on. This object is needed
for various parts of the validation process. The object may be null,
in which case areas of validation that require a logon will
not be validated.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 methods on other objects.VWException
- Thrown if an error occurs during the validation
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |