Package org.alfresco.module.org_alfresco_module_rm.report

Interface ReportService

All Known Implementing Classes:
ReportServiceImpl
@AlfrescoPublicApi public interface ReportService
Report service.
Since:
2.1
Author:
Roy Wetherall

  • Method Details

    • registerReportGenerator

      void registerReportGenerator(ReportGenerator reportGenerator)
      Register a report generator with the report service.
      Parameters:
      reportGenerator - report generator

    • getReportTypes

      Set<QName> getReportTypes()
      Get a list of the available report types.
      Returns:
      Set<QName> list of the available report types

    • generateReport

      Report generateReport(QName reportType, NodeRef reportedUponNodeRef)
      Generate a report of the given type and reported upon node reference.
      Parameters:
      reportType - report type
      reportedUponNodeRef - reported upon node reference
      Returns:
      Report generated report

    • generateReport

      Report generateReport(QName reportType, NodeRef reportedUponNodeRef, String mimetype)
      Generate a report for a specified mimetype.
      Parameters:
      reportType - report type
      reportedUponNodeRef - report upon node reference
      mimetype - report mimetype
      Returns:
      Report generated report
      See Also:

    • fileReport

      NodeRef fileReport(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 reference
      report - report
      Returns:
      NodeRef node reference of the filed report