|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWMapNode | +--filenet.vw.api.VWCompoundStepDefinition
The VWCompoundStepDefinition class creates, deletes, and orders a series of workflow map nodes that execute various action types of workflow system instructions. Use the VWCompoundStepDefinition class to access timers, to make calls to sub-maps (instruction sheets), and to perform additional workflow map functions shown in the method summary.
VWActionType
,
VWMapDefinition
,
VWMapNode
,
VWStepDefinition
,
VWInstructionDefinition
,
VWException
, Serialized FormFields inherited from class filenet.vw.api.VWMapNode |
POST_RULESETS, PRE_RULESETS, UPDATE_RULESETS |
Method Summary | |
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 |
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 |
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 |
createTerminateInstruction()
Creates a Terminate 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. |
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 VWRuleSetDefinitions for this compound step definition. |
java.lang.String |
toString()
Gets the name of this compound step definition object. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWCompoundStepDefinition object to the buffer specified by the input parameter. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this VWCompoundStepDefinition object. |
Methods inherited from class filenet.vw.api.VWMapNode |
createRoute, deleteRoute, getDescription, getJoinType, getLocation, getName, getNextRoutes, getNodeType, getPreviousRoutes, getRoute, getRouteFrom, getRouteTo, getRuleSets, getSplitType, getStepId, reorderRoutes, setDescription, setJoinType, setLocation, setName, setSplitType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public VWInstructionDefinition[] getInstructions() throws VWException
VWException
- public void setInstructions(VWInstructionDefinition[] theInstructions) throws VWException
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.
theInstructions
- The array of VWInstructionDefinition
objects to be changed in this compound step.VWException
- public void deleteInstruction(int theInstructionId) throws VWException
theInstructionId
- An integer containing the ID of the
instruction to be deleted.VWException
- public VWInstructionDefinition createCallInstruction(java.lang.String theMapName) throws VWException
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.VWException
- public VWInstructionDefinition createDelayInstruction(java.lang.String delay) throws VWException
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. VWException
- public VWInstructionDefinition createWFEInstruction(java.lang.String theTimeOut, java.lang.String theEventNumLocation) throws VWException
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.
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.VWException
- public VWInstructionDefinition createEndTimerInstruction(java.lang.String theTimer) throws VWException
theTimer
- the name of the timer that you want to end.VWException
- public VWInstructionDefinition createResumeTimerInstruction(java.lang.String theTimer) throws VWException
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.VWException
- public VWInstructionDefinition createSuspendTimerInstruction(java.lang.String timer) throws VWException
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.VWException
- public VWInstructionDefinition createReturnInstruction(java.lang.String retryOption) throws VWException
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 |
retryOption
- A String containing a Boolean expression. The
expression's effects are according to the method description above.VWException
- public VWInstructionDefinition createExecuteInstruction(java.lang.String theQueueName, java.lang.String theOperationName, java.lang.String[] theParamList) throws VWException
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.VWException
- public VWInstructionDefinition createDatabaseExecuteInstruction(java.lang.String theDatabaseName, java.lang.String theProcedureName, java.lang.String[] theParamList) throws VWException
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.VWException
- public VWInstructionDefinition createCreateInstruction(java.lang.String theWorkClassName, java.lang.String[][] theFieldAssignList) throws VWException
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).
VWException
- public VWInstructionDefinition createRollbackCheckpointInstruction(java.lang.String theReDoFlag, java.lang.String theCompCallIS, java.lang.String[] theNonRollbackFieldList) throws VWException
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.
CompCallIS
- 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.VWException
- public VWInstructionDefinition createAssignInstruction(java.lang.String[][] assignPairs) throws VWException
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).
VWException
- public VWInstructionDefinition createTerminateInstruction() throws VWException
This system instruction prematurely ends processing of a work object. The behavior of Terminate varies depending on the instruction sheet it is on:
On the terminate instruction sheet, terminate immediately terminates the work object.
On all other instruction sheets, terminate 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.
In all cases, upon Terminate system instruction execution, all active, suspended, or disabled timers for the work object are ended.
The new instruction will be added to the end of the list of instructions currently in this compound step. An Instruction ID will be generated automatically.
VWException
- public VWInstructionDefinition createNoOpInstruction() throws VWException
VWException
- public VWInstructionDefinition createBeginCheckPointInstruction() throws VWException
VWException
- public VWInstructionDefinition createEndCheckPointInstruction() throws VWException
VWException
- public VWInstructionDefinition createEndAllTimersInstruction() throws VWException
VWException
- public VWInstructionDefinition createBeginTimerInstruction(java.lang.String theTimerName, java.lang.String theExpirationTime, java.lang.String theISName, java.lang.String thePreemptiveExpirationExpr) throws VWException
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.
VWException
- public VWInstructionDefinition createLogInstruction(java.lang.String theEventType, java.lang.String theEventText) throws VWException
theEventType
- A String containing an integer expression
that evaluates to the event number, which must be greater than
1000.theEventText
- A String containing the message
to be logged, up to 250 characters long.VWException
- public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
validate
in class VWMapNode
theSession
- The session object if logged on. This object is needed
for various parts of the validation process. The object may be null,
but areas of validation that require a logon will not be validated.EDefVector
- a Vector to which will be added any VWValidationErrors found during this call, the Vector
may already contain some validation errors from previous calls to validate on other
objects.VWException
- Thrown if it cannot validate this
VWCompoundStepDefinition object.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is non-extensible, and cannot be modified in any way.
toXML
in class VWMapNode
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules) throws VWException
setRuleSets
in class VWMapNode
ruleSetSelector
- an int which specifies whether
the caller wants to have the rule apply in either a
pre- or post- step time frame. This parameter value must be
either VWMapNode.PRE_RULESETS
or VWMapNode.POST_RULESETS
.VWMapNode.UPDATE_RULESETS
value cannot be specified
for a VWCompoundStepDefinition object.theRules
- an array of the VWRuleSetDefinition objects for
this step. The VWRuleSetDefinitions in the array must be
references to VWRuleSetDefinition objects which exist in the
current workflow definition.VWException
- Thrown if there is a low-level array access
system error.public java.lang.String toString()
toString
in class VWMapNode
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |