com.opensymphony.workflow.util
Class Caller

java.lang.Object
  |
  +--com.opensymphony.workflow.util.Caller
All Implemented Interfaces:
FunctionProvider

public class Caller
extends java.lang.Object
implements FunctionProvider

Sets the persistent variable "caller" to the current user executing an action.

Version:
$Revision: 1.9 $
Author:
Patrick Lightbody

Constructor Summary
Caller()
           
 
Method Summary
 void execute(java.util.Map inputs, java.util.Map properties, java.util.Map variables)
          Execute this function
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Caller

public Caller()
Method Detail

execute

public void execute(java.util.Map inputs,
                    java.util.Map properties,
                    java.util.Map variables)
Description copied from interface: FunctionProvider
Execute this function
Specified by:
execute in interface FunctionProvider
Following copied from interface: com.opensymphony.workflow.FunctionProvider
Parameters:
inputs - Workflow inputs
properties - 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.

See www.opensymphony.com for more information.