com.ibm.pim.extensionpoints
Interface ReportGenerateFunctionArguments


public interface ReportGenerateFunctionArguments

Interface defining the arguments passed to ReportGenerateFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.Map getInputs()
          Obtains the inputs held in the docstore for this ReportGenerateFunction.
 PIMWriter getOutput()
          Obtains access to the writer for output created by this CatalogExportFunction.
 PIMProgress getProgress()
          Obtains a WPCProgress object that can be used to report execution progress for this invocation.
 

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 CatalogExportFunction.

The output writer is where the report should be written to.

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

getInputs

java.util.Map getInputs()
Obtains the inputs held in the docstore for this ReportGenerateFunction.

Map is
String of Input Spec Attribute Instance Path -> String of Value.


getProgress

PIMProgress getProgress()
Obtains a WPCProgress object that can be used to report execution progress for this invocation.