|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ReportConfigurationBean
- This bean contains details of a single report's configuration.public interface IReportingAdminService<ReportConfigurationBean>
Provides functionality to produce (on-demand and schedule) reports for resources stored on this repository and other repositories (using URLs).
Method Summary | |
---|---|
void |
copySavedReport(String name,
String newName)
Method to copy saved report |
void |
deleteSavedReport(String name)
Method to delete saved report |
String[] |
getAttributeNames(String className)
Method to retrieve the list of properties that can be passed to the report generator class |
String[] |
getMandatoryAttributeNames(String className)
Method to retrieve the list of mandatory properties that can be passed to the report generator class |
byte[] |
getReportBytes(ReportConfigurationBean configuration)
Method to obtain a stream of bytes of the generated report. |
ReportConfigurationBean |
getSavedReport(String name)
Method to retrieve a saved report |
ReportConfigurationBean[] |
getSavedReports()
Method to retrieve saved report |
void |
saveReport(ReportConfigurationBean configuration)
Method to save a report |
void |
scheduleReport(ReportConfigurationBean configuration)
Method to schedule the generation of a report |
void |
stopScheduledReport(String name)
Method to stop the generation of a scheduled report |
Method Detail |
---|
byte[] getReportBytes(ReportConfigurationBean configuration) throws Exception
configuration
- the report configuration
Exception
- if the operation failedvoid scheduleReport(ReportConfigurationBean configuration) throws Exception
configuration
- the report configuration
Exception
- if the operation failedvoid stopScheduledReport(String name) throws Exception
name
- the name of the report
Exception
- if the operation failedvoid saveReport(ReportConfigurationBean configuration) throws org.wso2.carbon.registry.core.exceptions.RegistryException, org.wso2.carbon.core.util.CryptoException
configuration
- the report's configuration
org.wso2.carbon.registry.core.exceptions.RegistryException
- if the failure was from the registry
org.wso2.carbon.core.util.CryptoException
- if the failure was when performing data encryptionReportConfigurationBean[] getSavedReports() throws org.wso2.carbon.registry.core.exceptions.RegistryException, org.wso2.carbon.core.util.CryptoException, org.wso2.carbon.ntask.common.TaskException
org.wso2.carbon.registry.core.exceptions.RegistryException
- if the failure was from the registry
org.wso2.carbon.core.util.CryptoException
- if the failure was when performing data encryption
org.wso2.carbon.ntask.common.TaskException
- if the failure was when retrieving details of the scheduled tasks.ReportConfigurationBean getSavedReport(String name) throws org.wso2.carbon.registry.core.exceptions.RegistryException, org.wso2.carbon.core.util.CryptoException, org.wso2.carbon.ntask.common.TaskException
name
- the name of the report
org.wso2.carbon.registry.core.exceptions.RegistryException
- if the failure was from the registry
org.wso2.carbon.core.util.CryptoException
- if the failure was when performing data encryption
org.wso2.carbon.ntask.common.TaskException
- if the failure was when retrieving details of the scheduled tasks.void deleteSavedReport(String name) throws org.wso2.carbon.registry.core.exceptions.RegistryException
name
- the name of the report
org.wso2.carbon.registry.core.exceptions.RegistryException
- if the failure was from the registryvoid copySavedReport(String name, String newName) throws org.wso2.carbon.registry.core.exceptions.RegistryException
name
- the name of the reportnewName
- the new name for the copy
org.wso2.carbon.registry.core.exceptions.RegistryException
- if the failure was from the registryString[] getAttributeNames(String className) throws Exception
className
- the fully qualified name of the
Exception
- if the operation failedString[] getMandatoryAttributeNames(String className) throws Exception
className
- the fully qualified name of the
Exception
- if the operation failed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |