| com.opensymphony.workflow.FunctionProvider
All known Subclasses: com.opensymphony.workflow.util.ScheduleJob, com.opensymphony.workflow.util.ejb.remote.RemoteEJBFunctionProvider, com.opensymphony.workflow.util.jndi.JNDIFunctionProvider, com.opensymphony.workflow.loader.JDBCWorkflowFactory, com.opensymphony.workflow.util.VerifyCurrentSteps, com.opensymphony.workflow.util.UnscheduleJob, com.opensymphony.workflow.util.bsf.BSFFunctionProvider, com.opensymphony.workflow.util.EJBInvoker, com.opensymphony.workflow.util.XWorkExecutor, com.opensymphony.workflow.util.beanshell.BeanShellFunctionProvider, com.opensymphony.workflow.util.ejb.local.LocalEJBFunctionProvider, com.opensymphony.workflow.util.VerifyArg, com.opensymphony.workflow.util.JMSMessage, com.opensymphony.workflow.util.WebWorkExecutor, com.opensymphony.workflow.util.MostRecentOwner, com.opensymphony.workflow.util.SendEmail, com.opensymphony.workflow.util.Caller,
| FunctionProvider | | public interface FunctionProvider (Code) | | 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 | |
| public void | execute(Map transientVars, Map args, PropertySet ps)
Execute this function
Parameters:
transientVars - Variables that will not be persisted. |
| execute | | public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException(Code) | | Execute this function
Parameters:
transientVars - Variables that will not be persisted. These include inputsgiven in the Workflow.initialize and Workflow.doAction method calls.There are a number of special variable names:Also, any variable set as a com.opensymphony.workflow.Register), will also beavailable in the transient map, no matter what. These transient variables only last throughthe method call that they were invoked in, such as Workflow.initializeand Workflow.doAction.
Parameters:
args - The properties for this function invocation. Properties are createdfrom arg nested elements within the xml, an arg element takes in a name attributewhich is the properties key, and the CDATA text contents of the element map tothe property value.
Parameters:
ps - The persistent variables that are associated with the currentinstance of the workflow. Any change made to the propertyset are persisted tothe propertyset implementation's persistent store. |
|
|