com.ibm.pim.extensionpoints
Interface CollaborationItemMacroFunctionArguments

All Superinterfaces:
FunctionArguments

public interface CollaborationItemMacroFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to EntryMacroFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 CollaborationItem getCollaborationItem()
          Obtains the item entry being processed for this EntrymacroFunction.
 CollaborationStep getCollaborationStep()
          Obtains the collaboration step for this EntryMacroFunction.
 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.
 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.

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.

getCollaborationItem

CollaborationItem getCollaborationItem()
Obtains the item entry being processed for this EntrymacroFunction.


getCollaborationStep

CollaborationStep getCollaborationStep()
Obtains the collaboration step for this EntryMacroFunction.