Process Class Relationships

filenet.vw.api
Class VWStepDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWMapNode
        |
        +--filenet.vw.api.VWStepDefinition
All Implemented Interfaces:
filenet.vw.api.IVWHasParameterDefs, java.io.Serializable

public final class VWStepDefinition
extends VWMapNode
implements java.io.Serializable, filenet.vw.api.IVWHasParameterDefs

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:

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

Field 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

LVALUE

public static final int LVALUE
Integer value of 0: this constant can be used to subscript into the pre or post assignment arrays.

RVALUE

public static final int RVALUE
Integer value of 1: this constant can be used to subscript into the pre or post assignment arrays.
Method Detail

createParameter

public VWParameterDefinition createParameter(java.lang.String theName,
                                             int theMode,
                                             java.lang.String theValue,
                                             int theType,
                                             boolean theIsArray)
                                      throws VWException
Creates a parameter definition with input name, direction, value, and type information.
Parameters:
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.
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 - The method throws an exception if it cannot delete a parameter definition from the set of parameter definitions stored in this step.
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.
Specified by:
getParameterDefinition in interface filenet.vw.api.IVWHasParameterDefs
Parameters:
theName - The name of the parameter for which you seek the definition.
Returns:
A VWParameterDefinition object that represents the parameter named in the theName parameter.
See Also:
VWParameterDefinition

getParameterDefinitions

public VWParameterDefinition[] getParameterDefinitions()
                                                throws VWException
Gets all parameter definitions stored in the step definition.
Returns:
An array of VWParameterDefinition objects that contains the parameter definitions for the step.
See Also:
VWParameterDefinition

getCanReassign

public boolean getCanReassign()
Determines whether the user can reassign this step.
Returns:
A Boolean value. The method returns true if the user can reassign this step (as the value of the canReassign property of the step); otherwise, the method returns false.

setCanReassign

public void setCanReassign(boolean theFlag)
Sets the canReassign property of the step. If the property values is set to true, the user can reassign the current step.
Parameters:
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.

getCanViewStatus

public boolean getCanViewStatus()
Determines whether or not the user can view the status of the current step.
Parameters:
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.

setCanViewStatus

public void setCanViewStatus(boolean theFlag)
Sets the step's canViewStatus property to indicate whether the user can view the status of this step.
Parameters:
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.

toString

public java.lang.String toString()
Gets the name of the step definition object.
Overrides:
toString in class VWMapNode
Returns:
The name of 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.

setParticipants

public void setParticipants(VWParticipant[] theParticipants)
Sets the participants 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.

getQueueName

public java.lang.String getQueueName()
Gets the name of the queue associated with this step.
Returns:
The name of the queue associated with the step, which is the contents of the queueName property for the step. If the step has no associated queue, the method returns null.

setQueueName

public void setQueueName(java.lang.String theName)
Sets (or associates) a queue with the current step.
Parameters:
theName - The name of the queue with which you wish to associate the step.

getOperationName

public java.lang.String getOperationName()
Gets the name of the Operation associated with this step.
Returns:
The name of the Operation associated with the step, which is the contents of the operationName property for the step. If the step has no associated operation, the method returns null.

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.

getOperationParameters

public java.lang.String[] getOperationParameters()
Gets the array of Strings containing 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 the step has no associated operation parameters, the method returns null.

setOperationParameters

public void setOperationParameters(java.lang.String[] theParams)
Sets an array of Strings containing the parameter expressions for the Operation associated with this step.
Parameters:
theParams - A string array containing the parameters for the Operation associated with the step.

getRequestedInterface

public java.lang.String getRequestedInterface()
Gets the requested interface of the step (usually a step processor name associated with the top level UI).
Returns:
The requested interface (value of the requestedInterface property) of the step. If no requested interface for the step, the method returns null.

setRequestedInterface

public void setRequestedInterface(java.lang.String theInterface)
Requests an interface for the step (usually a a step processor name associated with the top level UI).
Parameters:
theInterface - The new requested interface (value of the requestedInterface property) of the step.

getResponses

public java.lang.String[] getResponses()
Gets the responses to this step.
Returns:
An array of response strings in the responses property of the step. If no responses exist for the step, the method returns null.

setResponses

public void setResponses(java.lang.String[] theResponses)
Sets the responses to this step.
Parameters:
theResponses - An array of strings containing the responses to place in the responses property of the step.

getDeadline

public long getDeadline()
Gets the deadline property 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 value of the deadline property for the step.

setDeadline

public void setDeadline(long theDeadline)
                 throws VWException
Sets the deadline of 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 number specifying the dead line period, in minutes.
Throws:
VWException - The method throws an exception if the theDeadline parameter contains a negative value.

getReminder

public long getReminder()
Gets the value of 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 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.
Returns:
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 if there is no post-milestone associated with this step.

setPostMilestone

public void setPostMilestone(java.lang.String mileStoneName)
                      throws VWException
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.
Parameters:
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.
Throws:
VWException - Thrown if the milestone name is invalid.

setPreMilestone

public void setPreMilestone(java.lang.String mileStoneName)
                     throws VWException
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.
Parameters:
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.
Throws:
VWException - Thrown if the milestone name is invalid

getPreMilestone

public 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.
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 preAssignments property value for the step, which defines field values to be set before the step processes. The use of assignment methods is described in detail in the setPreAssignments(java.lang.String[][]) method.
Returns:
A two-dimensional array of Strings representing the preAssignments for the current step.
See Also:
LVALUE, RVALUE, setPostAssignments(java.lang.String[][]), getPostAssignments(), setPreAssignments(java.lang.String[][])

setPreAssignments

public void setPreAssignments(java.lang.String[][] thePreAssignments)
                       throws VWException
Sets the PreAssignments property value for the step, which defines field values to be set before the step processes.
Parameters:
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).

Throws:
VWException - Thrown if thePreAssignments 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 postAssignments property value for the step, which defines field values to be set after the step processes. The use of assignment methods is described in detail in the setPreAssignments(java.lang.String[][]) method.
Returns:
A two dimensional array of Strings representing the postAssignments for the current step.
See Also:
LVALUE, RVALUE, setPreAssignments(java.lang.String[][]), getPreAssignments(), setPreAssignments(java.lang.String[][])

setPostAssignments

public void setPostAssignments(java.lang.String[][] thePostAssignments)
                        throws VWException
Sets the PostAssignments property value for the step, which defines field values to be set after the step processes.
Parameters:
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).

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

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Returns:
A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
Sets a VWAttribute object containing attributes for this object.
Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException -  
See Also:
getAttributeInfo()

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWStepDefinition object to the buffer specified by the input parameter.
Overrides:
toXML in class VWMapNode
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
for example if the input buffer is null.

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Validate this VWStepDefinition object.
Overrides:
validate in class VWMapNode
Parameters:
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.
Returns:
void, but the EDefVector will be updated to contain any validation errors found during this call.
Throws:
VWException - Thrown if an error occurs during the validation

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.