com.opensymphony.workflow
Interface FunctionProvider
- All Known Implementing Classes:
- UnscheduleJob, ScheduleJob, Caller, MostRecentOwner, SendEmail, JMSMessage, EJBInvoker
- public interface FunctionProvider
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.
- Version:
- $Revision: 1.9 $
- Author:
- Patrick Lightbody
Method Summary |
void |
execute(java.util.Map inputs,
java.util.Map properties,
java.util.Map variables)
Execute this function |
execute
public void execute(java.util.Map inputs,
java.util.Map properties,
java.util.Map variables)
- Execute this function
- Parameters:
inputs
- Workflow inputsproperties
- 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.variables
- The global, persistent variables that are associated with the current instance of the workflow.
Any change made to this map will be seen on the next function call in the workflow lifetime. There are two
special variable names: entry (object type: WorkflowEntry
) and
context (object type: WorkflowContext
). These are always available in the variable map,
no matter what. Also, any variable set as a register (see: Register
), will also
be available in the variable map, no matter what.