Interface ReportService
- All Known Implementing Classes:
ReportServiceImpl
@AlfrescoPublicApi
public interface ReportService
Report service.
- Since:
- 2.1
- Author:
- Roy Wetherall
-
Method Summary
Modifier and TypeMethodDescriptionfileReport
(NodeRef nodeRef, Report report) File report in the given destination.generateReport
(QName reportType, NodeRef reportedUponNodeRef) Generate a report of the given type and reported upon node reference.generateReport
(QName reportType, NodeRef reportedUponNodeRef, String mimetype) Generate a report for a specified mimetype.Get a list of the available report types.void
registerReportGenerator
(ReportGenerator reportGenerator) Register a report generator with the report service.
-
Method Details
-
registerReportGenerator
Register a report generator with the report service.- Parameters:
reportGenerator
- report generator
-
getReportTypes
Get a list of the available report types. -
generateReport
Generate a report of the given type and reported upon node reference.- Parameters:
reportType
- report typereportedUponNodeRef
- reported upon node reference- Returns:
Report
generated report
-
generateReport
Generate a report for a specified mimetype.- Parameters:
reportType
- report typereportedUponNodeRef
- report upon node referencemimetype
- report mimetype- Returns:
Report
generated report- See Also:
-
fileReport
File report in the given destination. If the given node reference is a file plan node reference the report will be filed in the unfiled records container.- Parameters:
nodeRef
- node referencereport
- report- Returns:
- NodeRef node reference of the filed report
-