|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Report
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.
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 |
---|
Distribution getDistribution()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.ScriptInputSpec getScriptInputSpec()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.lang.String getInputParameterValue(java.lang.String parameterPath)
parameterPath
- The path of the report input parameter
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.void setInputParameterValue(java.lang.String parameterPath, java.lang.String parameterValue)
parameterPath
- The path of a report input parameterparameterValue
- The value of a report parameter as a String.
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |