com.ibm.pim.extensionpoints
Interface CustomToolsFunctionArguments

All Superinterfaces:
FunctionArguments

public interface CustomToolsFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to CustomToolsFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.io.PrintWriter getErrors()
          Obtains access to the writer for error output created by this invocation.
 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 CustomToolsFunction.
 javax.servlet.http.HttpServletResponse getResponse()
          Obtains HTTP response being processed for this CustomToolsFunction.
 java.io.PrintWriter getWarnings()
          Obtains access to the writer for warning output created by this invocation.
 
Methods inherited from interface com.ibm.pim.extensionpoints.FunctionArguments
getCustomParameter, setCustomParameter
 

Field Detail

copyright

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

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.

getErrors

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

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

getWarnings

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

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

getResponse

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

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


getRequest

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