|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMapNode
filenet.vw.api.VWCompoundStepDefinition
public final class VWCompoundStepDefinition
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.
VWActionType
,
VWMapDefinition
,
VWMapNode
,
VWStepDefinition
,
VWInstructionDefinition
,
VWException
,
Serialized FormField 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 |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWParameterDefinition getParameterDefinition(java.lang.String theName) throws VWException
theName
-
VWException
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 createInvokeInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName) throws VWException
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.
VWException
VWPartnerLinkDefinition
,
VWWorkflowDefinition
public VWInstructionDefinition createReplyInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName) throws VWException
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.
VWException
public VWInstructionDefinition createReceiveInstruction(java.lang.String thePartnerLinkName, java.lang.String theOperationName) throws VWException
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.
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.
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.
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
VWException
- public VWInstructionDefinition createTerminateBranchInstruction() throws VWException
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.
VWActionType.ACTION_TYPE_TERMINATE_BRANCH
.
VWException
public VWInstructionDefinition createTerminateProcessInstruction() throws VWException
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.
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 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.
VWException
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
validate
in class VWMapNode
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.EDefVector
- A Vector to which will be added a VWValidationError object for each validation
error found. This can be null; in this case, a new Vector is used.
Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
Note: The EDefVector parameter is updated to contain any validation errors found.VWException
- Thrown if an error occurs during the validation.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in class VWMapNode
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
toXPDL
in class VWMapNode
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void setRuleSets(int ruleSetSelector, VWRuleSetDefinition[] theRules) throws VWException
setRuleSets
in class VWMapNode
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.
VWException
- Thrown if there is a low-level array access error.public java.lang.String toString()
toString
in class VWMapNode
public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |