Process API

filenet.vw.api
Class VWCompoundStepDefinition

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

public final class VWCompoundStepDefinition
extends VWMapNode
implements java.io.Serializable

Use this class to create, delete, and order a series of workflow map nodes to execute various action types of workflow system instructions. You can also access timers to make calls to sub-maps.

Since:
eProcess 4.20
See Also:
VWActionType, VWMapDefinition, VWMapNode, VWStepDefinition, VWInstructionDefinition, VWException, Serialized Form

Field Summary
 
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.
 VWInstructionDefinition createAssignInstruction(java.lang.String[][] assignPairs)
          Creates an Assign instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createBeginCheckPointInstruction()
          Creates a begin checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createBeginTimerInstruction(java.lang.String theTimerName, java.lang.String theExpirationTime, java.lang.String theISName, java.lang.String thePreemptiveExpirationExpr)
          Creates a begin timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createCallInstruction(java.lang.String theMapName)
          Creates a call instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createCreateInstruction(java.lang.String theWorkClassName, java.lang.String[][] theFieldAssignList)
          Creates a Create instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createDatabaseExecuteInstruction(java.lang.String theDatabaseName, java.lang.String theProcedureName, java.lang.String[] theParamList)
          Creates a Database Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createDelayInstruction(java.lang.String delay)
          Creates a delay instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createEndAllTimersInstruction()
          Creates an end all timers instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createEndCheckPointInstruction()
          Creates an end checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createEndTimerInstruction(java.lang.String theTimer)
          Creates an End Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createExecuteInstruction(java.lang.String theQueueName, java.lang.String theOperationName, java.lang.String[] theParamList)
          Creates an Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createInvokeInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName)
          Creates an invoke instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.
 VWInstructionDefinition createLogInstruction(java.lang.String theEventType, java.lang.String theEventText)
          Creates a log instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createNoOpInstruction()
          Creates a NoOp instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createReceiveInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName)
          Creates an receive instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.
 VWInstructionDefinition createReplyInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName)
          Creates a reply instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.
 VWInstructionDefinition createResumeTimerInstruction(java.lang.String theTimer)
          Creates a Resume Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createReturnInstruction(java.lang.String retryOption)
          Creates a Return instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createRollbackCheckpointInstruction(java.lang.String theReDoFlag, java.lang.String theCompCallIS, java.lang.String[] theNonRollbackFieldList)
          Creates a Rollback Checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createSuspendTimerInstruction(java.lang.String timer)
          Creates a Suspend Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createTerminateBranchInstruction()
          Creates a terminate branch instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createTerminateInstruction()
          Deprecated. Use createTerminateBranchInstruction() instead. The old terminate instruction was renamed terminateBranch to distinguish it from the newer terminateProcess instruction. This method will create a terminateBranch instruction.
 VWInstructionDefinition createTerminateProcessInstruction()
          Creates a terminate process instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step.
 VWInstructionDefinition createWFEInstruction(java.lang.String theTimeOut, java.lang.String theEventNumLocation)
          Creates a Wait For Event instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
 void deleteInstruction(int theInstructionId)
          Deletes an instruction from this compound step definition, specified by the instruction id.
 VWInstructionDefinition[] getInstructions()
          Gets the instructions contained in this VWCompoundStepDefinition instance.
 VWParameterDefinition getParameterDefinition(java.lang.String theName)
          A stub method, always returning null, implemented to make this class conform to the IVWHasParameterDefs interface.
 VWSession getSession()
          Get the session associated with this parameter container definition.
 void setInstructions(VWInstructionDefinition[] theInstructions)
          Changes the list instructions (as shown by getInstructions()) contained in this VWCompoundStepDefinition instance, without adding or deleting members: the number of elements in the list does not change.
 void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules)
          Sets the rule set (VWRuleSetDefinitions) to use for this instance.
 java.lang.String toString()
          Gets the name of this instance.
 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, setSplitType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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

getParameterDefinition

public VWParameterDefinition getParameterDefinition(java.lang.String theName)
                                             throws VWException
A stub method, always returning null, implemented to make this class conform to the IVWHasParameterDefs interface.
NOTE: Compound steps do not have parameters.

Parameters:
theName -
Returns:
null
Throws:
VWException

getInstructions

public VWInstructionDefinition[] getInstructions()
                                          throws VWException
Gets the instructions contained in this VWCompoundStepDefinition instance.

Returns:
An array of all VWInstructionDefinition objects contained in this VWCompoundStepDefinition object. The returned array has the same number of elements as the number of instructions in the compound step, and there are no empty elements in the array. If there are no instructions defined in the compound step, the method returns null.
Throws:
VWException

setInstructions

public void setInstructions(VWInstructionDefinition[] theInstructions)
                     throws VWException
Changes the list instructions (as shown by getInstructions()) contained in this VWCompoundStepDefinition instance, without adding or deleting members: the number of elements in the list does not change. This method could be used to change the order of the instructions within this compound step definition, for example. Any instructions currently contained in the step will be overwritten.

Parameters:
theInstructions - The array of VWInstructionDefinition objects to be changed in this compound step.
Throws:
VWException
See Also:
Create and delete methods

deleteInstruction

public void deleteInstruction(int theInstructionId)
                       throws VWException
Deletes an instruction from this compound step definition, specified by the instruction id. The element in the instruction list for this compound step is removed.

Parameters:
theInstructionId - An integer containing the ID of the instruction to be deleted.
Throws:
VWException

createCallInstruction

public VWInstructionDefinition createCallInstruction(java.lang.String theMapName)
                                              throws VWException
Creates a call instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theMapName - The name of the map (instruction sheet) to be called when this call instruction is executed. This name must exist either in the current workflow or among the workflow maps inherited by the current workflow definition.
Returns:
A new VWInstructionDefinition object with an action type of call.
Throws:
VWException

createDelayInstruction

public VWInstructionDefinition createDelayInstruction(java.lang.String delay)
                                               throws VWException
Creates a delay instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
delay - A valid time expression that returns the desired delay expiration time. Details of time expressions are described in the "Expressions" book of the Reference section of the Designer User documentation.
Returns:
A new VWInstructionDefinition object with an action type of delay.
Throws:
VWException

createWFEInstruction

public VWInstructionDefinition createWFEInstruction(java.lang.String theTimeOut,
                                                    java.lang.String theEventNumLocation)
                                             throws VWException
Creates a Wait For Event instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theTimeOut - a valid time expression representing the amount of time this instruction will wait for an event to occur. Details of time expressions are described in the "Expressions" book of the Reference section of the Designer User documentation.
Note: A value of "0" specifies waiting indefinitely.
theEventNumLocation - A valid Lvalue expression, which specifies the location where this instruction will store the number of the event which occurred. For example, this parameter could be the name of a field in this Workflow definition.
Returns:
A new VWInstructionDefinition object with an action type of wait for event.
Throws:
VWException

createInvokeInstruction

public VWInstructionDefinition createInvokeInstruction(java.lang.String thePartnerLinkName,
                                                       java.lang.String theOperationName)
                                                throws VWException
Creates an invoke instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.

Parameters:
thePartnerLinkName - The partner link name of the invoke instruction. The partner link name must be the name of a partner link in the workflow definition that contains this invoke instruction.
theOperationName - The operation name of this invoke instruction. The operation name must be the name of an operation on the port type defined in the partner link.
Returns:
A new VWInstructionDefinition object with an invoke action type.
Throws:
VWException
See Also:
VWPartnerLinkDefinition, VWWorkflowDefinition

createReplyInstruction

public VWInstructionDefinition createReplyInstruction(java.lang.String thePartnerLinkName,
                                                      java.lang.String theOperationName)
                                               throws VWException
Creates a reply instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.

Parameters:
thePartnerLinkName - The partner link name of the reply instruction. The partner link name must be the name of a partner link in the workflow definition that contains this reply instruction.
theOperationName - The operation name of this reply instruction. The operation name must be the name of an operation on the port type defined in the partner link.
Returns:
A new VWInstructionDefinition object with a reply action type.
Throws:
VWException

createReceiveInstruction

public VWInstructionDefinition createReceiveInstruction(java.lang.String thePartnerLinkName,
                                                        java.lang.String theOperationName)
                                                 throws VWException
Creates an receive instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list.

Parameters:
thePartnerLinkName - The partner link name of the receive instruction. The partner link name must be the name of a partner link in the workflow definition that contains this receive instruction.
theOperationName - The operation name of this receive instruction. The operation name must be the name of an operation on the port type defined in the partner link.
Returns:
A new VWInstructionDefinition object with a receive action type.
Throws:
VWException

createEndTimerInstruction

public VWInstructionDefinition createEndTimerInstruction(java.lang.String theTimer)
                                                  throws VWException
Creates an End Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theTimer - the name of the timer that you want to end.
Returns:
A new VWInstructionDefinition object with an action type of End Timer.
Throws:
VWException

createResumeTimerInstruction

public VWInstructionDefinition createResumeTimerInstruction(java.lang.String theTimer)
                                                     throws VWException
Creates a Resume Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theTimer - The name (case-sensitive) of the suspended timer (SuspendTimer system instruction) that you want to restore. The ResumeTimer system instruction has no effect if you pass the name of a non-existent timer.
Returns:
A new VWInstructionDefinition object with an action type of Resume Timer.
Throws:
VWException

createSuspendTimerInstruction

public VWInstructionDefinition createSuspendTimerInstruction(java.lang.String timer)
                                                      throws VWException
Creates a Suspend Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
timer - the name (case-sensitive) of the timer (defined in the corresponding BeginTimer Instruction) that you want to suspend. The SuspendTimer system instruction has no effect if you enter the name of a non-existent timer.
Returns:
A new VWInstructionDefinition object with an action type of Suspend Timer.
Throws:
VWException

createReturnInstruction

public VWInstructionDefinition createReturnInstruction(java.lang.String retryOption)
                                                throws VWException
Creates a Return instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

The Return system instruction immediately exits from a called instruction sheet and returns to the calling instruction sheet. On the calling instruction sheet, either the Instruction that caused the call executes again, or the next Instruction executes. Which action occurs depends on both: The retryOption (a boolean expression) designated for the Return system instruction AND the type of instruction sheet that contains the Return system instruction.

In the summary below, "next" means the Instruction following the Instruction that caused the call executes; "repeat" means the Instruction that caused the call executes again.


instruction sheet containing Return is: Retry option = true Retry option = false
An exception-handling instruction sheet called by the system, or the VW_RaiseException API raised an exception repeat next
An instruction sheet called via the Call system instruction or VW_Call API repeat next
A timer expiration instruction sheet called because it is designated (in a BeginTimer system instruction) to be called if a timer expires repeat repeat

Parameters:
retryOption - A String containing a Boolean expression. The expression's effects are according to the method description above.
Returns:
A new VWInstructionDefinition object with an action type of Return.
Throws:
VWException

createExecuteInstruction

public VWInstructionDefinition createExecuteInstruction(java.lang.String theQueueName,
                                                        java.lang.String theOperationName,
                                                        java.lang.String[] theParamList)
                                                 throws VWException
Creates an Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theQueueName - The name of the workperformer class or queue which exposes the operation to be executed.
theOperationName - A string, the name of the operation to be executed.
theParamList - array of parameter expressions needed to execute the operation. The length of the array should equal the number of parameters needed by the operation named by theOperationName.
Returns:
A new VWInstructionDefinition object with an action type of Execute.
Throws:
VWException

createDatabaseExecuteInstruction

public VWInstructionDefinition createDatabaseExecuteInstruction(java.lang.String theDatabaseName,
                                                                java.lang.String theProcedureName,
                                                                java.lang.String[] theParamList)
                                                         throws VWException
Creates a Database Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theDatabaseName - The name of the database which contains the stored procedure to be executed.
theProcedureName - The name of the stored procedure to be executed.
theParamList - array of parameter expressions needed to execute the stored procedure. The length of the array should equal the number of parameters needed by the procedure named by theProcedureName argument.
Returns:
A new VWInstructionDefinition object with an action type of Database Execute.
Throws:
VWException

createCreateInstruction

public VWInstructionDefinition createCreateInstruction(java.lang.String theWorkClassName,
                                                       java.lang.String[][] theFieldAssignList)
                                                throws VWException
Creates a Create instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theWorkClassName - The name of the WorkClass to be created.
theFieldAssignList - A two-dimensional array of Strings containing field initialization pairs: field name and initial value assignment; may also be empty (null value).

The first "column" of this array comprises the left-side values of a set of assignment operations. Each string in this "column" is a field name. The number of "rows" in the array (the first dimension) is the number of assignment operations to be executed when the instruction runs.

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, a function call, or an array initialization expression).

Returns:
A new VWInstructionDefinition object with an action type of Create.
Throws:
VWException

createRollbackCheckpointInstruction

public VWInstructionDefinition createRollbackCheckpointInstruction(java.lang.String theReDoFlag,
                                                                   java.lang.String theCompCallIS,
                                                                   java.lang.String[] theNonRollbackFieldList)
                                                            throws VWException
Creates a Rollback Checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theReDoFlag - a Boolean expression that determines where processing resumes after the rollback occurs. The expression must meet specific guidelines for expressions; for detailed information about expression guidelines refer to the Expressions book: Reference section, in the Designer online help. This parameter may be null, which would be equivalent to the default value ("True").

If the expression evaluates to true, the instructions immediately following BeginCheckPoint execute. This means that RollBackCheckPoint will execute.

If the expression evaluates to false, RollBackCheckPoint is skipped: the instruction immediately following RollBackCheckPoint executes.

theCompCallIS - A compensation instruction sheet (map) name, which may be null.
theNonRollbackFieldList - An array of user-defined field names. This parameter may be null. These fields will not be rolled back when the rollback checkpoint instruction executes. By default, all user-defined field values will be rolled back to the values they contained when the begin checkpoint instruction executed.
Returns:
A new VWInstructionDefinition object with an action type of Rollback Checkpoint.
Throws:
VWException

createAssignInstruction

public VWInstructionDefinition createAssignInstruction(java.lang.String[][] assignPairs)
                                                throws VWException
Creates an Assign instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

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

Returns:
A new VWInstructionDefinition object with an action type of assign.
Throws:
VWException

createTerminateInstruction

public VWInstructionDefinition createTerminateInstruction()
                                                   throws VWException
Deprecated. Use createTerminateBranchInstruction() instead. The old terminate instruction was renamed terminateBranch to distinguish it from the newer terminateProcess instruction. This method will create a terminateBranch instruction.

Returns:
a terminate branch instruction
Throws:
VWException -


createTerminateBranchInstruction

public VWInstructionDefinition createTerminateBranchInstruction()
                                                         throws VWException
Creates a terminate branch instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step.

This system instruction prematurely ends processing of a work object. Other work objects in the same workflow will continue processing. For example, if splits have occurred, there may be more than one work object in the same workflow (process). They will have the same F_WorkFlowNumber, but different F_WobNum values.

The behavior of terminate branch depends on the instruction sheet it is on:

When terminate branch executes, all active, suspended, or disabled timers for the work object are ended.

The new instruction is added to the end of the list of instructions currently in this compound step. An Instruction ID is generated automatically.

Returns:
A new VWInstructionDefinition object with an action type of VWActionType.ACTION_TYPE_TERMINATE_BRANCH.
Throws:
VWException

createTerminateProcessInstruction

public VWInstructionDefinition createTerminateProcessInstruction()
                                                          throws VWException
Creates a terminate process instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step.

This system instruction prematurely ends processing of all work objects in a process (all work objects having the same value for F_WorkFlowNumber). If, during process execution, a work object split into multiple work objects, they will all be terminated when one of them executes a terminate process instruction.

The behavior of terminate process depends on the instruction sheet it is on:

On the terminate instruction sheet, terminate process immediately terminates the work object.

On all other instruction sheets, terminate process calls the terminate instruction sheet defined in or inherited by the work object?s work class. The work object is then processed and ultimately terminated according to the logic of the terminate instruction sheet.

When terminate process executes, all active, suspended, or disabled timers for the work object are ended.

The new instruction is added to the end of the list of instructions currently in this compound step. An Instruction ID is generated automatically.

Returns:
A new VWInstructionDefinition object with an action type of Terminate Process.
Throws:
VWException

createNoOpInstruction

public VWInstructionDefinition createNoOpInstruction()
                                              throws VWException
Creates a NoOp instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step. A NoOp is a dummy instruction. NoOp is short for "No Operation". NoOps are stripped out of the runtime instruction sheets by the server. A NoOp can be useful as a place holder.

Returns:
A new VWInstructionDefinition object with an action type of NoOp.
Throws:
VWException

createBeginCheckPointInstruction

public VWInstructionDefinition createBeginCheckPointInstruction()
                                                         throws VWException
Creates a begin checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Returns:
A new VWInstructionDefinition object with an action type of begin checkpoint.
Throws:
VWException

createEndCheckPointInstruction

public VWInstructionDefinition createEndCheckPointInstruction()
                                                       throws VWException
Creates an end checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Returns:
A new VWInstructionDefinition object with an action type of end checkpoint.
Throws:
VWException

createEndAllTimersInstruction

public VWInstructionDefinition createEndAllTimersInstruction()
                                                      throws VWException
Creates an end all timers instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Returns:
A new VWInstructionDefinition object with an action type of end all timers.
Throws:
VWException

createBeginTimerInstruction

public VWInstructionDefinition createBeginTimerInstruction(java.lang.String theTimerName,
                                                           java.lang.String theExpirationTime,
                                                           java.lang.String theISName,
                                                           java.lang.String thePreemptiveExpirationExpr)
                                                    throws VWException
Creates a begin timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theTimerName - The name of the timer.

theExpirationTime - A time expression which will evaluate to the time that the timer will expire. This expression could be a literal time value, a time expression such as "addminutes(systemtime(),45)" (meaning "45 minutes from now").

theISName - Name of the instruction sheet (or "map") to call if the timer expires. Details of time expressions are described in the "Expressions" book of the Reference section of the Designer User documentation.

thePreemptiveExpirationExpr - This string expression may be null, which indicates the work object stays locked (it is "non-preemptive") after a timer expiration time. A non-preemptive timer will wait until the work object is unlocked before it expires.

A time expression specifies the time period that elapses after the expiration time, before a lock on the work object is removed ("preempted"). Details of time expressions are defined in the "Expressions" book of the Reference section of the Designer User documentation.

Returns:
A new VWInstructionDefinition object with an action type of begin timer.
Throws:
VWException

createLogInstruction

public VWInstructionDefinition createLogInstruction(java.lang.String theEventType,
                                                    java.lang.String theEventText)
                                             throws VWException
Creates a log instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.

Parameters:
theEventType - A String containing an integer expression that evaluates to the event number, which must be between 1000 and 32766 inclusive. If the expression evaluates to a number outside that range at runtime, the server will coerce the number into that range, by taking the absolute value, modulo 31766, and adding 1000 to it, so , for example, 32767 will belogged as 2001..
theEventText - A String containing the message to be logged, up to 250 characters long.
Returns:
A new VWInstructionDefinition object with an action type of log.
Throws:
VWException

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.

Note: The EDefVector parameter is updated to contain any validation errors found.
Throws:
VWException - Thrown if an error occurs during the validation.

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

setRuleSets

public void setRuleSets(int ruleSetSelector,
                        VWRuleSetDefinition[] theRules)
                 throws VWException
Sets the rule set (VWRuleSetDefinitions) to use for this instance.

Overrides:
setRuleSets in class VWMapNode
Parameters:
ruleSetSelector - An integer specifying whether the caller wants the rule to apply prior to or after the step. This can be either VWMapNode.PRE_RULESETS or VWMapNode.POST_RULESETS.

Note: The VWMapNode.UPDATE_RULESETS value cannot be specified for a VWCompoundStepDefinition object.

theRules - An array of the VWRuleSetDefinition objects for this compound step. The VWRuleSetDefinition objects must exist in the current workflow definition.
Throws:
VWException - Thrown if there is a low-level array access error.
See Also:
VWMapNode Field Summary

toString

public java.lang.String toString()
Gets the name of this instance.

Specified by:
toString in class VWMapNode
Returns:
The name of this compound step definition object.

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.