com.bea.wlpi.server.plugin
Interface ActionContext
- public interface ActionContext
Provides run-time context and services to plugin actions. The framework
passes an instance of this interface to the PluginAction.execute(com.bea.wlpi.server.plugin.ActionContext, com.bea.wlpi.server.common.ExecutionContext)
method.
- Since:
- WebLogic Process Integrator 2.0
- See Also:
PluginAction
,
ActionInfo
executeSubActionList
public int executeSubActionList(int index,
ExecutionContext context)
throws WorkflowException
- Iterate through a list of sub-actions, executing each in turn. The
index value identifies which sub-action list to execute. If an exception
occurs, invoke the current error handler.
- Parameters:
index
- The index of the sub-action list to execute. It
equates to the index in the classNames
member of the
corresponding ActionInfo
.context
- The execution context passed by the caller.- Returns:
- Indicates whether (and how) to continue subsequent processing:
ExecutionContext.CONTINUE
or ExecutionContext.STOP
.
If the return value is other than
ExecutionContext.CONTINUE
, the caller must
return immediately, passing on this return value. - Throws:
WorkflowException
-
getActionId
public java.lang.String getActionId()
- Return the ID that uniquely identifies this action. This ID is required
to support asynchronously executed callbacks to plugin-defined actions:
the ID must be passed to the
Worklist.response(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
method.
- Returns:
- String The action's unique ID.
instantiateWorkflow
public java.lang.String instantiateWorkflow(ExecutionContext context,
java.lang.String orgID,
java.lang.String templateID,
VariableInfo[] initialValues,
java.util.Map pluginData)
throws WorkflowException
- Create a new workflow instance.
- Parameters:
context
- The execution context passed by the caller.orgID
- The ID of the organization in which to instantiate the
workflow.templateID
- The ID of the workflow template to instantiate.initialValues
- Initial values for workflow variables.pluginData
- A collection of plugin-defined instance data. The
map is keyed on plugin name, and each element is a plugin-defined
instance datum.- Returns:
- A response string as described under
Worklist.taskExecute(java.lang.String, java.lang.String, java.lang.String)
. The
caller can perform a SAX parse of this XML document to obtain the
instanceID
and templateDefinitionID
of the new
instance. - Throws:
WorkflowException
- if the workflow could not be instantiated.
BEA WebLogic Process Integrator is a trademark of BEA Systems, Inc.
Copyright (c) 2001 BEA Systems, Inc.
All rights reserved.