|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This Block manages reports. Some responsibilities to be covered by blocks implementing this interface are:
Public access to the report intances happens using the Report
interface.
Field Summary | |
static java.lang.String |
ROLE
|
Method Summary | |
Report |
createInstance(java.lang.String reportDefinitionId,
java.lang.String dataSourceId,
User user,
ResourceHandle resourceHandle)
Create a new report instance. |
boolean |
destroyReport(User user,
java.lang.String reportInstanceId)
Deletes all trace of the given report by calling its dispose method and removing its handle from the list of current instances. |
void |
generateCatalog(org.xml.sax.ContentHandler contentHandler,
User user,
java.lang.String dataSourceId,
ResourceHandle resourceHandle)
Generates a catalog of available report definitions. |
void |
generateReportInstanceList(org.xml.sax.ContentHandler contentHandler)
Generates a list of all report instances. |
Report |
getReport(java.lang.String reportInstanceId,
User user)
Gets an existing report instance. |
ReportDefinition |
getReportDefinition(java.lang.String reportDefinitionId,
User user)
|
void |
setListener(java.lang.String name,
java.net.InetSocketAddress listener,
boolean discloseHostName,
boolean disclosePortNumber)
Specify information about the environment this instance is listening on. |
Field Detail |
public static final java.lang.String ROLE
Method Detail |
public void setListener(java.lang.String name, java.net.InetSocketAddress listener, boolean discloseHostName, boolean disclosePortNumber)
public Report createInstance(java.lang.String reportDefinitionId, java.lang.String dataSourceId, User user, ResourceHandle resourceHandle) throws UnknownReportDefintionIdException, UnknownDataSourceIdException, java.lang.Exception
This method will also check that the user has the rights to use the report and datasource.
UnknownReportDefintionIdException
UnknownDataSourceIdException
java.lang.Exception
public Report getReport(java.lang.String reportInstanceId, User user) throws UnknownReportId, ReportInUseException, DataSourceAccessDeniedException, ReportAccessDeniedException, UnknownDataSourceIdException, AuthorisationException
This method will also check that the user has the rights to use the report and associated datasource.
UnknownReportId
ReportInUseException
DataSourceAccessDeniedException
ReportAccessDeniedException
UnknownDataSourceIdException
AuthorisationException
public void generateCatalog(org.xml.sax.ContentHandler contentHandler, User user, java.lang.String dataSourceId, ResourceHandle resourceHandle) throws org.xml.sax.SAXException, UnknownDataSourceIdException, DataSourceAccessDeniedException, AuthorisationException
AuthorisationManager
),
and with which the datasource is compatible. Additionaly, an
exception will be thrown when the user has no access to the data source (also controlled by the AuthorisationManager).
org.xml.sax.SAXException
UnknownDataSourceIdException
DataSourceAccessDeniedException
AuthorisationException
public boolean destroyReport(User user, java.lang.String reportInstanceId) throws UnknownReportId
UnknownReportId
public void generateReportInstanceList(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public ReportDefinition getReportDefinition(java.lang.String reportDefinitionId, User user) throws UnknownReportDefintionIdException, ReportAccessDeniedException, ReportDefinitionViewingNotAllowedException, AuthorisationException
UnknownReportDefintionIdException
ReportAccessDeniedException
ReportDefinitionViewingNotAllowedException
AuthorisationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |