Process API

filenet.vw.api
Class VWStepDefinition

java.lang.Object
  extended by filenet.vw.api.VWMapNode
      extended by filenet.vw.api.VWStepDefinition
All Implemented Interfaces:
filenet.vw.api.IVWCanCreateParameters, IVWPastable, java.io.Serializable, java.lang.Cloneable

public final class VWStepDefinition
extends VWMapNode
implements java.io.Serializable, filenet.vw.api.IVWCanCreateParameters, java.lang.Cloneable

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.

Since:
VWWS3.10
See Also:
VWRouteDefinition, VWParameterDefinition, VWMapDefinition, VWMapNode, VWJoinType, VWSplitType, VWException, Serialized Form

Field 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

LVALUE

public static final int LVALUE
Value of 0: Used as a subscript for the pre or post-assignment arrays.

See Also:
Constant Field Values

RVALUE

public static final int RVALUE
Value of 1: Used as a subscript for the pre or post-assignment arrays.

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.

Returns:
the file author

_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.

Returns:
the file revision number

createParameter

public VWParameterDefinition createParameter(java.lang.String theName,
                                             int theMode,
                                             java.lang.String theValue,
                                             int theType,
                                             boolean theIsArray)
                                      throws VWException
Creates a parameter with name, direction, value, and type information.

Specified by:
createParameter in interface filenet.vw.api.IVWCanCreateParameters
Parameters:
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.
Returns:
A VWParameterDefinition object that represents the newly created parameter definition.
Throws:
VWException - Triggers include the following:

  • Invalid theName parameter
  • Parameter by that name already exists
  • Invalid field type
  • Invalid mode type

See Also:
VWParameterDefinition, VWModeType

deleteParameter

public void deleteParameter(java.lang.String theName)
                     throws VWException
Deletes a parameter definition from the set of parameter definitions stored in this step.

Parameters:
theName - The name of the parameter definition to be deleted.
Throws:
VWException - One example of an exception situation would be if the input parameter name were invalid.
See Also:
VWParameterDefinition

getParameterDefinition

public VWParameterDefinition getParameterDefinition(java.lang.String theName)
                                             throws VWException
Gets a parameter definition from the set of parameter definitions stored in this step definition.

Parameters:
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).

Returns:
A VWParameterDefinition object for the specified parameter.
Throws:
VWException - Thrown if the specified parameter cannot be found.
See Also:
VWParameterDefinition

getParameterDefinitions

public VWParameterDefinition[] getParameterDefinitions()
                                                throws VWException
Gets the parameter definitions stored in this step definition. If a translation source exists, the authored names are 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).

Returns:
An array of VWParameterDefinition objects that contains the parameter definitions for this step. If a translation source exists, the translated parameter names are returned; otherwise, the authored names are returned.
Throws:
VWException - Thrown if the returned array contains an object of an unsupported type.
See Also:
VWParameterDefinition

getCanReassign

public boolean getCanReassign()
Indicates whether the user can reassign this step.

Returns:
true indicates the user is allowed to reassign the current step; false indicates the user is denied the ability to reassign the step.

setCanReassign

public void setCanReassign(boolean theFlag)
Sets the canReassign property of the step: inputting TRUE will signify that the user can reassign the current step.

Parameters:
theFlag - true allows the user to reassign the current step; false denies the user the ability to reassign the step.

getIgnoreInvalidUsers

public boolean getIgnoreInvalidUsers()
Gets the current value of the flag which determines how an invalid step participant will be treated at runtime.

Returns:
true means invalid participants will be ignored at runtime; false means that an invalid participant will cause an exception at runtime.

setIgnoreInvalidUsers

public 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. 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.

Parameters:
theFlag - true means invalid participants will be ignored at runtime; false means that an invalid participant will cause an exception at runtime.

getCanViewStatus

public boolean getCanViewStatus()
Gets the current value of the flag that indicates whether or not the user can view the status of the current step.

Returns:
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.

setCanViewStatus

public void setCanViewStatus(boolean theFlag)
Sets the step's canViewStatus property to specify whether the user can view the status of this step.

Parameters:
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.

getCanViewHistory

public boolean getCanViewHistory()
Indicates whether the user can view the history at the current step.

Returns:
true if the user is allowed to view the history of the step; false, otherwise.
Since:
eP6.0

setCanViewHistory

public void setCanViewHistory(boolean bFlag)
Sets the step's canViewHistory property to specify whether the user can view the history at this step.

Parameters:
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.
Since:
eP6.0

toString

public java.lang.String toString()
Gets the name of the step definition object.

Specified by:
toString in class VWMapNode
Returns:
Name of the step definition object.

getParticipants

public VWParticipant[] getParticipants()
Gets the participants property value for the step.

Returns:
An array of VWParticipant objects representing the participants for the current step.
See Also:
VWParticipant

setParticipants

public void setParticipants(VWParticipant[] theParticipants)
Sets the participant's property value for the step.

Parameters:
theParticipants - An array of VWParticipant objects that represent the name of the set of participants to be associated with the step.
See Also:
VWParticipant

getQueueName

public java.lang.String getQueueName()
Gets the name of the queue associated with this step. If a translation source exists, the authored queue 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).

Returns:
A String containing the translated queue name, if a translation source exists; otherwise the authored name is returned. If the queue name cannot be found, null is returned.
See Also:
VWQueueDefinition

setQueueName

public void setQueueName(java.lang.String theName)
Associates the named queue with the current step.

Parameters:
theName - The name of the queue with which you wish to associate the step.
See Also:
VWQueueDefinition

getOperationName

public java.lang.String getOperationName()
Gets the name of the operation associated with this step. 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).

Returns:
A String containing the translated name of the operation associated with the step, if a translation source exists; otherwise, the authored name is returned. If this step has no associated operation, null is returned.
See Also:
VWOperationDefinition

setOperationName

public void setOperationName(java.lang.String theName)
Sets (or associates) an operation with the current step.

Parameters:
theName - The name of the operation with which you wish to associate the step.
See Also:
VWOperationDefinition

getOperationParameters

public java.lang.String[] getOperationParameters()
Gets the parameter expressions for the operation associated with this step.

Returns:
A String array containing the parameter expressions for the operation associated with the step. If this step has no associated operation parameters, the method returns null.
See Also:
VWOperationDefinition, setOperationParameters

setOperationParameters

public void setOperationParameters(java.lang.String[] theParams)
Specifies the parameter expressions for the operation associated with this step.

Parameters:
theParams - A String array containing the parameters for the operation associated with this step.
See Also:
VWOperationDefinition, getOperationParameters

getRequestedInterface

public 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).

Returns:
A String containing the name of the interface for the step. If no requested interface for the step, the method returns null.
See Also:
setRequestedInterface

setRequestedInterface

public 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).

Parameters:
theInterface - A String containing the name of the interface for the step.
See Also:
getRequestedInterface

getResponses

public java.lang.String[] getResponses()
Gets the responses to this step. If a translation source exists, the authored responses are 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).

Returns:
A String containing the translated responses, if a translation source exists; otherwise the authored responses are returned. If no responses are found for this step, null is returned.
See Also:
setResponses

setResponses

public void setResponses(java.lang.String[] theResponses)
Sets the responses to this step.

Parameters:
theResponses - A String array containing the responses to use for this step. Leading and trailing white space is trimmed from the responses.
See Also:
getResponses

getDeadline

public long getDeadline()
Gets the deadline value for the step. The dead line value represents the number of minutes between receipt of the step by an application and expiration of the dead line timer at runtime. A deadline property value of 0 means the step has no deadline.

Returns:
A long indicating the value of the deadline property for the step. A value of zero means the step has no deadline, a value greater than zero is the number of minutes after work on the step begins that the deadline will expire. A value of -1 indicates that the step has a time expression that cannot be converted to a long.
See Also:
getDeadlineExpr, setDeadlineExpr

setDeadline

public void setDeadline(long theDeadline)
                 throws VWException
Sets the deadline for this step. The deadline value represents the number of minutes between receipt of the step by an application and expiration of the step's deadline timer at runtime. A deadline value of 0 means the step has no deadline.

Parameters:
theDeadline - A long specifying the dead line period, in minutes.
Throws:
VWException - Thrown if the theDeadline parameter contains a negative value.
See Also:
getDeadline

getDeadlineExpr

public java.lang.String getDeadlineExpr()
                                 throws VWException
Retrieves the value of the deadline expression property for this step definition. The deadline value is a time expression used to calculate the expiration of the deadline timer at run time.

Returns:
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.
Throws:
VWException
See Also:
setDeadlineExpr

setDeadlineExpr

public void setDeadlineExpr(java.lang.String theDeadlineExpr)
                     throws VWException
Sets the value of the deadline expression property for this step definition. The deadline value is a time expression used to calculate the expiration of the deadline timer at run time.

Parameters:
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.
Throws:
VWException
See Also:
getDeadlineExpr

getDeadlineMap

public java.lang.String getDeadlineMap()
Gets the name of the map to be called when the step deadline expires for this step definition. If a translation source exists, the authored map 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).

Returns:
A String containing the translated map name, if a translation source exists; otherwise, the authored name is returned.

setDeadlineMap

public void setDeadlineMap(java.lang.String theDeadlineMap)
Changes the name of the map to be called when the step deadline expires for this step definition.

Parameters:
theDeadlineMap - A String containing the name of the map to be called when the step deadline expires.

getReminder

public long getReminder()
Gets this step's reminder property. The reminder value represents the number of minutes prior to expiration of the deadline timer at which the reminder timer expires at runtime.

Returns:
A number representing the value of the reminder property for the step; if no reminder values exists, that is the reminder property contains 0 (zero), the step has no associated reminder.

getPostMilestone

public java.lang.String getPostMilestone()
Gets this step's post-milestone property. This is the name of a milestone in this workflow that is reached just after this step finishes execution.

Returns:
Name of a milestone in this workflow which is reached just after this step finishes execution, after any post-assignments are carried out. This may be null if there is no post-milestone associated with this step.

setPostMilestone

public void setPostMilestone(java.lang.String mileStoneName)
                      throws VWException
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.

Parameters:
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.
Throws:
VWException - Thrown if the milestone name is invalid.

setPreMilestone

public void setPreMilestone(java.lang.String mileStoneName)
                     throws VWException
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.

Parameters:
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.
Throws:
VWException - Thrown if the milestone name is invalid

getPreMilestone

public 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.

Returns:
the name of a milestone in this workflow which is reached just after this step executes, after any pre-assignments are carried out. May be null if there is no pre-milestone associated with this step.

setReminder

public void setReminder(long theReminder)
                 throws VWException
Sets the reminder value for the step. The reminder value represents the number of minutes prior to expiration of the deadline timer at which the reminder timer expires at runtime. A reminder property value of 0 (zero) means the step has no reminder.

Parameters:
theReminder - A number specifying the reminder period, in minutes.
Throws:
VWException - The method throws an exception if theReminder parameter contains a negative value.

getPreAssignments

public java.lang.String[][] getPreAssignments()
Gets the field values that are to be performed before the step is processed (see setPreAssignments(java.lang.String[][])).

Returns:
A two-dimensional String array containing pairs of left and right values of assignment operations that are to be performed when the post-assignments instruction executes.
See Also:
LVALUE, RVALUE, setPostAssignments(java.lang.String[][]), getPostAssignments()

setPreAssignments

public void setPreAssignments(java.lang.String[][] thePreAssignments)
                       throws VWException
Defines the field values to be performed before the step is processed.

Parameters:
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).

Throws:
VWException - Thrown if specified two-dimensional array is not properly dimensioned, or if any elements in the array are null.
See Also:
LVALUE, RVALUE, setPostAssignments(java.lang.String[][]), getPostAssignments(), getPreAssignments()

getPostAssignments

public java.lang.String[][] getPostAssignments()
Gets the field values that are to be performed after the step is processed (see setPostAssignments(java.lang.String[][])).

Returns:
A two-dimensional String array containing pairs of left and right values of assignment operations that are to be performed when the post-assignments instruction executes.
See Also:
LVALUE, RVALUE, getPreAssignments(), setPreAssignments(java.lang.String[][])

setPostAssignments

public void setPostAssignments(java.lang.String[][] thePostAssignments)
                        throws VWException
Defines the field values to be performed after the step is processed.

Parameters:
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).

Throws:
VWException - Thrown if specified two-dimensional array is not properly dimensioned, or if any elements in the array are null.
See Also:
LVALUE, RVALUE, setPreAssignments(java.lang.String[][]), getPreAssignments(), getPostAssignments()

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in class VWMapNode
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

toXPDL

public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
Appends an XPDL string representing this instance to the buffer specified.

Warning: This XPDL string is nonextensible, and cannot be modified in any way.

Specified by:
toXPDL in class VWMapNode
Parameters:
indentA - A String specifying the initial indentation for this XPDL section.
theBuffer - A StringBuffer that will be appended with the XPDL content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Validates this instance, appending any validation errors found to the specified Vector object.

Specified by:
validate in class VWMapNode
Parameters:
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.

Throws:
VWException - Thrown if an error occurs during the validation. ,.

getSession

public VWSession getSession()
                     throws VWException
Get the session associated with this parameter container definition.

Returns:
The session associated with this parameter container definition, may return null.
Throws:
VWException

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.