com.ibm.pim.extensionpoints
Interface DistributionFunctionArguments

All Superinterfaces:
FunctionArguments

public interface DistributionFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to DistributionFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 Document[] getDocuments()
          Obtains the documents to be distributed.
 PIMWriter getErrors()
          Obtains access to the writer for error output created by this DistributionFunction.
 PIMWriter getOutput()
          Obtains access to the writer for output created by this DistributionFunction.
 PIMWriter getWarnings()
          Obtains access to the writer for warning output created by this DistributionFunction.
 
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

PIMWriter getOutput()
Obtains access to the writer for output created by this DistributionFunction.

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

getErrors

PIMWriter getErrors()
Obtains access to the writer for error output created by this DistributionFunction.

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

getWarnings

PIMWriter getWarnings()
Obtains access to the writer for warning output created by this DistributionFunction.

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

getDocuments

Document[] getDocuments()
Obtains the documents to be distributed.