com.ibm.pim.extensionpoints
Interface TriggerFunctionArguments


public interface TriggerFunctionArguments

Interface defining the arguments passed to TriggerFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this invocation.
 javax.servlet.http.HttpServletRequest getRequest()
          Obtains HTTP request being processed for this TriggerFunction.
 javax.servlet.http.HttpServletResponse getResponse()
          Obtains HTTP response being processed for this TriggerFunction.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getResponse

javax.servlet.http.HttpServletResponse getResponse()
Obtains HTTP response being processed for this TriggerFunction.

To write output for the trigger function, use 'getOutput', rather than the direct writer available from the response.


getRequest

javax.servlet.http.HttpServletRequest getRequest()
Obtains HTTP request being processed for this TriggerFunction.


getOutput

java.io.PrintWriter getOutput()
Obtains access to the writer for output created by this invocation.

This is the writer that should be used to write the content that will be displayed as the custom tool.

Equivalent in Script API:
Equivalent to the script 'out' writer within the corresponding type of script.