Interface ReportService
-
- All Known Implementing Classes:
ReportServiceImpl
@AlfrescoPublicApi public interface ReportService
Report service.- Since:
- 2.1
- Author:
- Roy Wetherall
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.alfresco.service.cmr.repository.NodeRef
fileReport(org.alfresco.service.cmr.repository.NodeRef nodeRef, Report report)
File report in the given destination.Report
generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate a report of the given type and reported upon node reference.Report
generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate a report for a specified mimetype.Set<org.alfresco.service.namespace.QName>
getReportTypes()
Get a list of the available report types.void
registerReportGenerator(ReportGenerator reportGenerator)
Register a report generator with the report service.
-
-
-
Method Detail
-
registerReportGenerator
void registerReportGenerator(ReportGenerator reportGenerator)
Register a report generator with the report service.- Parameters:
reportGenerator
- report generator
-
getReportTypes
Set<org.alfresco.service.namespace.QName> getReportTypes()
Get a list of the available report types.- Returns:
Set
<QName
> list of the available report types
-
generateReport
Report generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
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
Report generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate a report for a specified mimetype.- Parameters:
reportType
- report typereportedUponNodeRef
- report upon node referencemimetype
- report mimetype- Returns:
Report
generated report- See Also:
generateReport(QName, NodeRef)
-
fileReport
org.alfresco.service.cmr.repository.NodeRef fileReport(org.alfresco.service.cmr.repository.NodeRef nodeRef, Report report)
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
-
-