public interface ViewReportAction extends CSOAction
Modifier and Type | Method and Description |
---|---|
java.lang.String |
generateReport(java.lang.String name,
java.lang.String type,
java.util.Collection<ReportParameter> parameters)
Generates a report in given format and returns the name of the temporary file.
|
java.lang.String |
generateReportAsExcel(java.lang.String name,
java.util.Collection<ReportParameter> parameters)
Generates a report in EXCEL format and returns the name of the temporary file.
|
java.lang.String |
generateReportAsHtml(java.lang.String name,
java.util.Collection<ReportParameter> parameters)
Returns the generated report as HTML.
|
java.lang.String |
generateReportAsPdf(java.lang.String name,
java.util.Collection<ReportParameter> parameters)
Generates a report in PDF format and returns the name of the temporary file.
|
java.lang.String |
generateReportAsWord(java.lang.String name,
java.util.Collection<ReportParameter> parameters)
Generates a report in WORD format and returns the name of the temporary file.
|
java.util.Collection<CentraSiteObject> |
getApplicableReports()
Returns the collection of all applicable reports.
|
ActionStateEnum |
getNextState() |
java.util.Collection<ReportParameter> |
getReportParameters()
Returns the parameter of a report.
|
CentraSiteObject |
getSelectedReport()
Returns the selected report.
|
void |
setNextState(ActionStateEnum nextState) |
void |
setSelectedReport(CentraSiteObject centraSiteObject)
Sets the selected report.
|
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
java.util.Collection<CentraSiteObject> getApplicableReports() throws CLLException
CentraSiteObject
(s)CLLException
- if CLL fails to return all the applicable reportsvoid setSelectedReport(CentraSiteObject centraSiteObject)
centraSiteObject
- Report as CentraSiteObject
CentraSiteObject getSelectedReport() throws CLLException
CentraSiteObject
CLLException
- if CLL fails to return the selected reportjava.lang.String generateReportAsHtml(java.lang.String name, java.util.Collection<ReportParameter> parameters) throws CLLException
name
- Display name of report to generate.parameters
- ReportParam
for the report to generate.CLLException
- if CLL fails to return the selected reportjava.lang.String generateReportAsPdf(java.lang.String name, java.util.Collection<ReportParameter> parameters) throws CLLException
name
- Display name of report to generate.parameters
- ReportParam
for the report to generate.CLLException
- if CLL fails to return the selected reportjava.lang.String generateReportAsWord(java.lang.String name, java.util.Collection<ReportParameter> parameters) throws CLLException
name
- Display name of report to generate.parameters
- ReportParam
for the report to generate.CLLException
- if CLL fails to return the selected reportjava.lang.String generateReportAsExcel(java.lang.String name, java.util.Collection<ReportParameter> parameters) throws CLLException
name
- Display name of report to generate.parameters
- ReportParam
for the report to generate.CLLException
- if CLL fails to return the selected reportjava.lang.String generateReport(java.lang.String name, java.lang.String type, java.util.Collection<ReportParameter> parameters) throws CLLException
name
- Display name of report to generate.type
- The type/format in which the report will be generated.parameters
- ReportParam
for the report to generate.CLLException
- if CLL fails to return the selected reportjava.util.Collection<ReportParameter> getReportParameters() throws CLLException
ReportParameter
CLLException
- if CLL fails to return the selected reportActionStateEnum getNextState()
void setNextState(ActionStateEnum nextState)