|
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: to create, delete, or modify step properties. Each step in a workflow map has a unique ID representing a unique logical unit of work in the workflow process sequence.
The step definition includes the following:
VWRouteDefinition
,
VWParameterDefinition
,
VWMapDefinition
,
VWMapNode
,
VWJoinType
,
VWSplitType
,
VWException
, Serialized FormField Summary | |
static int |
LVALUE
Value of 0: this constant can be used as a subscript for the pre or post assignment arrays. |
static int |
RVALUE
Value of 1: this constant can be used as a subscript for the pre or post assignment arrays. |
Fields inherited from class filenet.vw.api.VWMapNode |
POST_RULESETS, PRE_RULESETS, UPDATE_RULESETS |
Method Summary | |
VWParameterDefinition |
createParameter(java.lang.String theName,
int theMode,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter with 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()
Indicates whether the user can reassign this step. |
boolean |
getCanViewHistory()
the user can view the history at the current step. |
boolean |
getCanViewStatus()
Gets the current value of the flag that indicates 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 |
getDeadlineExpr()
Retrieves the value of the deadline expression property for this step definition. |
java.lang.String |
getDeadlineMap()
Gets the name of the map to be called when the step deadline expires for this step definition. |
boolean |
getIgnoreInvalidUsers()
Gets the current value of the flag which determines how an invalid step participant will be treated at runtime. |
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 the parameter definitions stored in the current 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: inputting TRUE will signify that the user can reassign the current step. |
void |
setCanViewHistory(boolean bFlag)
Sets the step's canViewHistory property to specify whether the user can view the history at this step. |
void |
setCanViewStatus(boolean theFlag)
Sets the step's canViewStatus property to specify whether the user can view the status of this step. |
void |
setDeadline(long theDeadline)
Sets the deadline of this step. |
void |
setDeadlineExpr(java.lang.String theDeadlineExpr)
Sets the value of the deadline expression property for this step definition. |
void |
setDeadlineMap(java.lang.String theDeadlineMap)
Changes the name of the map to be called when the step deadline expires for this step definition. |
void |
setIgnoreInvalidUsers(boolean theFlag)
Sets the ignoreInvalidUsers property of the step: inputting TRUE will signify that an invalid participant in this step at runtime will not cause an exception. |
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 participant's 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)
Associates the named 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 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, getRuleSets, getSplitType, getStepId, reorderRoutes, setDescription, setJoinType, setLocation, setName, setRuleSets, 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.
theValue
- A String representation of the value of the
parameter definition.
theType
- An integer value specifying the
field type
that applies to the value expression.
theIsArray
- A boolean expression: TRUE specifies the
value expression as 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
- One example of an exception situation
would be if the input parameter name were invalid.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: TRUE allows the user
to reassign the current step; FALSE denies the user
the ability to reassign the step.public boolean getIgnoreInvalidUsers()
public void setIgnoreInvalidUsers(boolean theFlag)
theFlag
- A boolean value: TRUE means invalid participants will be
ignored at runtime; FALSE means that an invalid participant will cause an
exception at runtime.public boolean getCanViewStatus()
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 boolean getCanViewHistory()
public void setCanViewHistory(boolean bFlag)
theFlag
- A boolean value. Specify TRUE to allow the user
to view the history of the step; specify FALSE to deny the
ability to view the history on the current step.public java.lang.String toString()
toString
in class VWMapNode
public VWParticipant[] getParticipants()
VWParticipant
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.VWParticipant
public java.lang.String getQueueName()
VWQueueDefinition
public void setQueueName(java.lang.String theName)
theName
- The name of the queue with which you wish to
associate the step.VWQueueDefinition
public java.lang.String getOperationName()
VWOperationDefinition
public void setOperationName(java.lang.String theName)
theName
- The name of the operation with
which you wish to associate the step.VWOperationDefinition
public java.lang.String[] getOperationParameters()
VWOperationDefinition
public void setOperationParameters(java.lang.String[] theParams)
theParams
- A String array containing the parameters for the operation
associated with the step.VWOperationDefinition
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()
getDeadlineExpr()
,
setDeadlineExpr(String)
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 java.lang.String getDeadlineExpr() throws VWException
VWException
- Thrown if error occurspublic void setDeadlineExpr(java.lang.String theDeadlineExpr) throws VWException
theDeadlineExpr
- A String containing a time expression or, for
backward compatibility, a number equal to the number of minutes
after work begins that the deadline will expire.
A returned deadline value of null means the
step has no deadline.VWException
- Thrown if error occurspublic java.lang.String getDeadlineMap()
public void setDeadlineMap(java.lang.String theDeadlineMap)
theDeadlineMap
- The name of the map to be called when the
step deadline expires.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
Warning: This XML String is non-extensible, and cannot be modified in any way.
toXML
in class VWMapNode
theBuffer
- A String buffer that this method will append with
XML content.VWException
- Thrown, for example if the input buffer is
null.VWXMLUtil
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 from previous
calls to validate methods on other objects.VWException
- Thrown if an error occurs during the validation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |