Package fr.becpg.repo.report.entity

Interface EntityReportService

All Known Implementing Classes:
EntityReportServiceImpl
public interface EntityReportService

EntityReportService interface.

Version:
$Id: $Id
Author:
matthieu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    REPORT_FORMULATION_CHAIN_ID
    Constant REPORT_FORMULATION_CHAIN_ID="ReportFormulationChainId"

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)
    generateReport.
    void
    generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef templateNodeRef, EntityReportParameters reportParameters, Locale locale, fr.becpg.report.client.ReportFormat reportFormat, OutputStream outputStream)
    generateReport.
    void
    generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef, fr.becpg.report.client.ReportFormat reportFormat, OutputStream outputStream)
    generateReport.
    void
    generateReports(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    generateReports.
    void
    generateReports(org.alfresco.service.cmr.repository.NodeRef nodeRefFrom, boolean generateAllReports)
    generateReports.
    void
    generateReports(org.alfresco.service.cmr.repository.NodeRef nodeRefFrom, org.alfresco.service.cmr.repository.NodeRef nodeRefTo)
    generateReports.
    org.alfresco.service.cmr.repository.NodeRef
    getAssociatedDocumentNodeRef(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef tplNodeRef, EntityReportParameters reportParameters, Locale locale, fr.becpg.report.client.ReportFormat reportFormat)
    getAssociatedDocumentNodeRef.
    org.alfresco.service.cmr.repository.NodeRef
    getEntityNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    getEntityNodeRef.
    org.alfresco.service.cmr.repository.NodeRef
    getOrRefreshReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)
    getOrRefreshReport.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getOrRefreshReportsOfKind(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String reportType)
    getOrRefreshReportsOfKind.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getReportsOfKind(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String reportType)
    getReportsOfKind.
    org.alfresco.service.cmr.repository.NodeRef
    getSelectedReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getSelectedReport.
    String
    getSelectedReportName(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getSelectedReportName.
    String
    getXmlReportDataSource(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Locale locale, EntityReportParameters reportParameters)
    getXmlReportDataSource.
    EntityReportExtractorPlugin
    retrieveExtractor(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    retrieveExtractor.
    void
    setPermissions(org.alfresco.service.cmr.repository.NodeRef tplNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)
    setPermissions.
    boolean
    shouldGenerateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)
    shouldGenerateReport.

  • Field Details

    • REPORT_FORMULATION_CHAIN_ID

      static final String REPORT_FORMULATION_CHAIN_ID
      Constant REPORT_FORMULATION_CHAIN_ID="ReportFormulationChainId"
      See Also:

  • Method Details

    • generateReports

      void generateReports(org.alfresco.service.cmr.repository.NodeRef nodeRefFrom, org.alfresco.service.cmr.repository.NodeRef nodeRefTo)

      generateReports.

      Parameters:
      nodeRefFrom - a NodeRef object
      nodeRefTo - a NodeRef object

    • generateReports

      void generateReports(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      generateReports.

      Parameters:
      entityNodeRef - a NodeRef object.

    • generateReport

      void generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)

      generateReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      documentNodeRef - a NodeRef object.

    • generateReport

      void generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef, fr.becpg.report.client.ReportFormat reportFormat, OutputStream outputStream)

      generateReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      documentNodeRef - a NodeRef object.
      reportFormat - a ReportFormat object.
      outputStream - a OutputStream object.

    • generateReport

      void generateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef templateNodeRef, EntityReportParameters reportParameters, Locale locale, fr.becpg.report.client.ReportFormat reportFormat, OutputStream outputStream)

      generateReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      templateNodeRef - a NodeRef object.
      reportParameters - a EntityReportParameters object.
      locale - a Locale object.
      reportFormat - a ReportFormat object.
      outputStream - a OutputStream object.

    • getOrRefreshReport

      org.alfresco.service.cmr.repository.NodeRef getOrRefreshReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)

      getOrRefreshReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      documentNodeRef - a NodeRef object.
      Returns:
      a NodeRef object.

    • getOrRefreshReportsOfKind

      List<org.alfresco.service.cmr.repository.NodeRef> getOrRefreshReportsOfKind(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String reportType)

      getOrRefreshReportsOfKind.

      Parameters:
      entityNodeRef - a NodeRef object
      reportType - a String object
      Returns:
      a List object

    • getXmlReportDataSource

      String getXmlReportDataSource(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Locale locale, EntityReportParameters reportParameters)

      getXmlReportDataSource.

      Parameters:
      entityNodeRef - a NodeRef object.
      locale - a Locale object.
      reportParameters - a EntityReportParameters object.
      Returns:
      a String object.

    • setPermissions

      void setPermissions(org.alfresco.service.cmr.repository.NodeRef tplNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)

      setPermissions.

      Parameters:
      tplNodeRef - a NodeRef object.
      documentNodeRef - a NodeRef object.

    • shouldGenerateReport

      boolean shouldGenerateReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef documentNodeRef)

      shouldGenerateReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      documentNodeRef - a NodeRef object.
      Returns:
      a boolean.

    • getSelectedReport

      org.alfresco.service.cmr.repository.NodeRef getSelectedReport(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getSelectedReport.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a NodeRef object.

    • getReportsOfKind

      List<org.alfresco.service.cmr.repository.NodeRef> getReportsOfKind(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String reportType)

      getReportsOfKind.

      Parameters:
      entityNodeRef - a NodeRef object
      reportType - a String object
      Returns:
      a List object

    • getSelectedReportName

      String getSelectedReportName(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getSelectedReportName.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a String object.

    • retrieveExtractor

      EntityReportExtractorPlugin retrieveExtractor(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      retrieveExtractor.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a EntityReportExtractorPlugin object.

    • getEntityNodeRef

      org.alfresco.service.cmr.repository.NodeRef getEntityNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)

      getEntityNodeRef.

      Parameters:
      nodeRef - a NodeRef object.
      Returns:
      a NodeRef object.

    • getAssociatedDocumentNodeRef

      org.alfresco.service.cmr.repository.NodeRef getAssociatedDocumentNodeRef(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef tplNodeRef, EntityReportParameters reportParameters, Locale locale, fr.becpg.report.client.ReportFormat reportFormat)

      getAssociatedDocumentNodeRef.

      Parameters:
      entityNodeRef - a NodeRef object.
      tplNodeRef - a NodeRef object.
      reportParameters - a EntityReportParameters object.
      locale - a Locale object.
      reportFormat - a ReportFormat object.
      Returns:
      a NodeRef object.

    • generateReports

      void generateReports(org.alfresco.service.cmr.repository.NodeRef nodeRefFrom, boolean generateAllReports)

      generateReports.

      Parameters:
      nodeRefFrom - a NodeRef object
      generateAllReports - a boolean