com.ibm.pim.job
Interface Report

All Superinterfaces:
Job, UserJob

public interface Report
extends UserJob

Interface for Report object. A report comprises of a script that can take input parameters. The report script is executed when the report is invoked.

Since:
6.0.0

Field Summary
 
Fields inherited from interface com.ibm.pim.job.Job
copyright
 
Method Summary
 Distribution getDistribution()
          Fetches the distribution used with this report
 java.lang.String getInputParameterValue(java.lang.String parameterPath)
          Fetches the value for a report parameter
 ScriptInputSpec getScriptInputSpec()
          Fetches the input spec for this report.
 void setInputParameterValue(java.lang.String parameterPath, java.lang.String parameterValue)
          Sets the value for a report parameter
 
Methods inherited from interface com.ibm.pim.job.UserJob
getName, getScript
 
Methods inherited from interface com.ibm.pim.job.Job
delete, getCreator, getDescription, getExecutable, getLastRunSchedule, getParameterNames, getParameterValue, getRecurring, getSchedules, save, setParameterValue, setRecurring
 

Method Detail

getDistribution

Distribution getDistribution()
Fetches the distribution used with this report

Returns:
A Distribution object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getScriptInputSpec

ScriptInputSpec getScriptInputSpec()
Fetches the input spec for this report.

Returns:
The ScriptInputSpec for this report.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getInputParameterValue

java.lang.String getInputParameterValue(java.lang.String parameterPath)
Fetches the value for a report parameter

Parameters:
parameterPath - The path of the report input parameter
Returns:
The value for the given report parameter as a String.
Throws:
PIMInternalException - If an internal error occurs
PIMInvalidPathException - If the parameter path does not exist in the script input spec
java.lang.IllegalArgumentException - If the parameterPath is null or empty.

setInputParameterValue

void setInputParameterValue(java.lang.String parameterPath,
                            java.lang.String parameterValue)
Sets the value for a report parameter

Parameters:
parameterPath - The path of a report input parameter
parameterValue - The value of a report parameter as a String.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
PIMInvalidPathException - If the parameter path does not exist in the script input spec
java.lang.IllegalArgumentException - If the parameterPath is null or empty
java.lang.UnsupportedOperationException - if the parameter is an enumeration and parameterValue is not present in the list of enumerated values.