com.opensymphony.workflow
Interface FunctionProviderRemote
- All Superinterfaces:
- Remote
public interface FunctionProviderRemote
- extends Remote
Remote interface to be implemented by any class that are to be called from within a workflow as a function,
either as a pre-function or a post-function. The args nested elements within the function xml call
will be mapped to the properties parameter.
- Author:
- Pat Lightbody
|
Method Summary |
void |
execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
Execute this function |
execute
void execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
throws RemoteException
- Execute this function
- Parameters:
transientVars - Variables that will not be persisted. These include inputs
given in the Workflow.initialize(java.lang.String, int, java.util.Map) and Workflow.doAction(long, int, java.util.Map) method calls.
There are two special variable names: entry (object type:
WorkflowEntry) and context
(object type: WorkflowContext).
Also, any variable set as a Register), will also be
available in the transient map, no matter what. These transient variables only last through
the method call that they were invoked in, such as Workflow.initialize(java.lang.String, int, java.util.Map)
and Workflow.doAction(long, int, java.util.Map).args - The properties for this function invocation. Properties are created
from arg nested elements within the xml, an arg element takes in a name attribute
which is the properties key, and the CDATA text contents of the element map to
the property value.ps - The persistent variables that are associated with the current
instance of the workflow. Any change made to the propertyset are persisted to
the propertyset implementation's persistent store.
- Throws:
RemoteException