|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMapNode
filenet.vw.api.VWStepDefinition
public final class VWStepDefinition
Use this class 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.
VWRouteDefinition
,
VWParameterDefinition
,
VWMapDefinition
,
VWMapNode
,
VWJoinType
,
VWSplitType
,
VWException
,
Serialized FormField Summary | |
---|---|
static int |
LVALUE
Value of 0: Used as a subscript for the pre or post-assignment arrays. |
static int |
RVALUE
Value of 1: 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 | |
---|---|
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. |
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. |
boolean |
getCanReassign()
Indicates whether the user can reassign this step. |
boolean |
getCanViewHistory()
Indicates whether 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 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 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 this step definition. |
VWParticipant[] |
getParticipants()
Gets the participants property value for the step. |
java.lang.String[][] |
getPostAssignments()
Gets the field values that are to be performed after the step is processed (see setPostAssignments(java.lang.String[][]) ). |
java.lang.String |
getPostMilestone()
Gets this step's post-milestone property. |
java.lang.String[][] |
getPreAssignments()
Gets the field values that are to be performed before the step is processed (see setPreAssignments(java.lang.String[][]) ). |
java.lang.String |
getPreMilestone()
Returns this step's pre-milestone property, which is the name of a milestone in this workflow that is reached just after this step executes. |
java.lang.String |
getQueueName()
Gets the name of the queue associated with this step. |
long |
getReminder()
Gets this step's reminder property. |
java.lang.String |
getRequestedInterface()
Gets the name of the interface used for the step (usually a step processor name associated with the top level UI). |
java.lang.String[] |
getResponses()
Gets the responses to this step. |
VWSession |
getSession()
Get the session associated with this parameter container definition. |
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 for 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: true signifies 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)
Specifies 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)
Defines the field values to be performed after the step is processed. |
void |
setPostMilestone(java.lang.String mileStoneName)
Sets 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)
Defines the field values to be performed before the step is processed. |
void |
setPreMilestone(java.lang.String mileStoneName)
Sets 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)
Specifies the interface the step is to use (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 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(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
Methods inherited from class filenet.vw.api.VWMapNode |
---|
createRoute, deleteRoute, getAttributeInfo, getDescription, getDocumentation, getJoinType, getLocation, getName, getNextRoutes, getNodeType, getPreviousRoutes, getRoute, getRouteFrom, getRouteTo, getRuleSetNames, getRuleSets, getSession, getSplitType, getStepId, reorderRoutes, setAttributeInfo, setDescription, setDocumentation, setJoinType, setLocation, setName, setRuleSets, 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 static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWParameterDefinition createParameter(java.lang.String theName, int theMode, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
createParameter
in interface filenet.vw.api.IVWCanCreateParameters
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
theName
- A String containing the name of the parameter. If a translation source exists, the
authored name is translated.
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 specified parameter cannot be found.VWParameterDefinition
public VWParameterDefinition[] getParameterDefinitions() 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 returned array contains an object of an unsupported type.VWParameterDefinition
public boolean getCanReassign()
true
indicates the user is allowed
to reassign the current step; false
indicates
the user is denied the ability to reassign the step.public void setCanReassign(boolean theFlag)
theFlag
- true
allows the user
to reassign the current step; false
denies the user
the ability to reassign the step.public boolean getIgnoreInvalidUsers()
true
means invalid participants will be
ignored at runtime; false
means that an invalid
participant will cause an exception at runtime.public void setIgnoreInvalidUsers(boolean theFlag)
true
signifies that an invalid participant in this
step at runtime will not cause an exception. This flag can be
used by a workflow designer
to control the runtime behavior in situations where a user may
no longer exist in the security system, but may still occur in the
participant list of a step.
theFlag
- true
means invalid participants will be
ignored at runtime; false
means that an
invalid participant will cause an exception at runtime.public boolean getCanViewStatus()
true
means that the user
can view the status of the step; false
means that
the user cannot view the status on the current step.public void setCanViewStatus(boolean theFlag)
theFlag
- 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()
true
if the user is allowed
to view the history of the step; false
, otherwise.public void setCanViewHistory(boolean bFlag)
bFlag
- specify true
for the user to view the
history of the current step; 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()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
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()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
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
,
setOperationParameters
public void setOperationParameters(java.lang.String[] theParams)
theParams
- A String array containing the parameters for
the operation associated with this step.VWOperationDefinition
,
getOperationParameters
public java.lang.String getRequestedInterface()
setRequestedInterface
public void setRequestedInterface(java.lang.String theInterface)
theInterface
- A String containing the name of the interface for the step.getRequestedInterface
public java.lang.String[] getResponses()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setResponses
public void setResponses(java.lang.String[] theResponses)
theResponses
- A String array containing the
responses to use for this step. Leading and trailing white space is trimmed from
the responses.getResponses
public long getDeadline()
getDeadlineExpr
,
setDeadlineExpr
public void setDeadline(long theDeadline) throws VWException
theDeadline
- A long specifying the dead line period,
in minutes.
VWException
- Thrown if the
theDeadline parameter contains a negative value.getDeadline
public java.lang.String getDeadlineExpr() throws VWException
VWException
setDeadlineExpr
public void setDeadlineExpr(java.lang.String theDeadlineExpr) throws VWException
theDeadlineExpr
- A String containing the 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
getDeadlineExpr
public java.lang.String getDeadlineMap()
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 setDeadlineMap(java.lang.String theDeadlineMap)
theDeadlineMap
- A String containing 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
- 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
- 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[][])
).
LVALUE
,
RVALUE
,
setPostAssignments(java.lang.String[][])
,
getPostAssignments()
public void setPreAssignments(java.lang.String[][] thePreAssignments) throws VWException
thePreAssignments
- A two-dimensional String array containing pairs of left and right values of
assignment operations that are to be performed when this instruction executes. The number elements in one of
the array dimensions is the number of assignment operations to be executed when the instruction runs.
The first array dimension contains the left-side values of a set of assignment operations. Each String is a field name. The field name can be subscripted (myField or myArrayField[3], for example).
The second array dimension contains the right-side values of a set of assignment operations. Each of these Strings can be any valid Process Engine expression (a literal constant, a number, a field name, an arithmetic expression, a boolean expression, or a function call).
VWException
- Thrown if specified two-dimensional 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()
setPostAssignments(java.lang.String[][])
).
LVALUE
,
RVALUE
,
getPreAssignments()
,
setPreAssignments(java.lang.String[][])
public void setPostAssignments(java.lang.String[][] thePostAssignments) throws VWException
thePostAssignments
- A two-dimensional String array containing pairs of left and right values of
assignment operations that are to be performed when this instruction executes. The number elements in one of
the array dimensions is the number of assignment operations to be executed when the instruction runs.
The first array dimension contains the left-side values of a set of assignment operations. Each String is a field name. The field name can be subscripted (myField or myArrayField[3], for example).
The second array dimension contains the right-side values of a set of assignment operations. Each of these Strings can be any valid Process Engine expression (a literal constant, a number, a field name, an arithmetic expression, a boolean expression, or a function call).
VWException
- Thrown if specified two-dimensional array is not properly dimensioned, or if any elements in
the array are null.LVALUE
,
RVALUE
,
setPreAssignments(java.lang.String[][])
,
getPreAssignments()
,
getPostAssignments()
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in class VWMapNode
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.
toXPDL
in class VWMapNode
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(VWSession theSession, java.util.Vector EDefVector) throws VWException
validate
in class VWMapNode
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.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.
,.public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |