com.softwareag.centrasite.api.csom.action
Interface ViewReportAction

All Superinterfaces:
CSOAction

public interface ViewReportAction
extends CSOAction

The ViewReportAction interface allows to view reports that are available for the CentraSite object. This interface contains various methods that facilitate to view a report that is applicable for the selected CentraSite object.


Method Summary
 java.util.Collection<CentraSiteObject> getApplicableReports()
          Returns the collection of all applicable reports.
 ReportFormats getReportFormat()
          Returns the report format.
 java.net.URL getReportURL()
          Returns the report URL.
 CentraSiteObject getSelectedReport()
          Returns the selected report.
 void setReportFormat(ReportFormats format)
          Sets the report format.
 void setSelectedReport(CentraSiteObject centraSiteObject)
          Sets the selected report.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.action.CSOAction
cancel, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
 

Method Detail

getApplicableReports

java.util.Collection<CentraSiteObject> getApplicableReports()
                                                            throws CLLException
Returns the collection of all applicable reports.

Returns:
Collection of reports as CentraSiteObject(s)
Throws:
CLLException - if CLL fails to return all the applicable reports

setSelectedReport

void setSelectedReport(CentraSiteObject centraSiteObject)
Sets the selected report.

Parameters:
centraSiteObject - Report as CentraSiteObject

getSelectedReport

CentraSiteObject getSelectedReport()
                                   throws CLLException
Returns the selected report.

Returns:
Report as CentraSiteObject
Throws:
CLLException - if CLL fails to return the selected report

getReportURL

java.net.URL getReportURL()
                          throws CLLException
Returns the report URL.

Returns:
Report URL
Throws:
CLLException - if CLL fails to return the report URL

setReportFormat

void setReportFormat(ReportFormats format)
Sets the report format.

Parameters:
format - ReportFormats

getReportFormat

ReportFormats getReportFormat()
Returns the report format.

Returns:
ReportFormats