Package fr.becpg.repo.report.template

Interface ReportTplService

All Known Implementing Classes:
ReportTplServiceImpl
public interface ReportTplService

ReportTplService interface.

Version:
$Id: $Id
Author:
matthieu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PARAM_VALUE_DESIGN_EXTENSION
    Constant PARAM_VALUE_DESIGN_EXTENSION=".rptdesign"
    static final String
    PARAM_VALUE_XLSMREPORT_EXTENSION
    Constant PARAM_VALUE_XLSMREPORT_EXTENSION=".xlsm"
    static final String
    PARAM_VALUE_XLSXREPORT_EXTENSION
    Constant PARAM_VALUE_XLSXREPORT_EXTENSION=".xlsx"
    static final String
    PARAM_VALUE_XMLREPORT_EXTENSION
    Constant PARAM_VALUE_XMLREPORT_EXTENSION=".xml"

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.alfresco.service.cmr.repository.NodeRef>
    cleanDefaultTpls(List<org.alfresco.service.cmr.repository.NodeRef> tplsNodeRef)
    Check the default reports (return one default tpl) if there is a user default tpl, remove system default tpl and keep user one
    org.alfresco.service.cmr.repository.NodeRef
    createTplRessource(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, String xmlFilePath, boolean overrideRessource)
    Create a resource for the report
    org.alfresco.service.cmr.repository.NodeRef
    createTplRptDesign(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, String tplName, String tplFilePath, ReportTplInformation tplInformation, boolean overrideTpl)
    Create the rptdesign node for the report
    org.alfresco.service.cmr.repository.NodeRef
    getAssociatedReportTemplate(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    Get the template associated to the report
    org.alfresco.service.cmr.repository.NodeRef
    getDefaultReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType)
    getDefaultReportTemplate.
    fr.becpg.report.client.ReportFormat
    getReportFormat(org.alfresco.service.cmr.repository.NodeRef tplNodeRef)
    Get the report format
    org.alfresco.service.cmr.repository.NodeRef
    getSystemReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
    Gets the system report template.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSystemReportTemplates(ReportType reportType, org.alfresco.service.namespace.QName nodeType)
    Gets the system report templates.
    org.alfresco.service.cmr.repository.NodeRef
    getUserReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
    Get the user template by name
    List<org.alfresco.service.cmr.repository.NodeRef>
    getUserReportTemplates(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
    Gets the user report templates.

  • Field Details

    • PARAM_VALUE_DESIGN_EXTENSION

      static final String PARAM_VALUE_DESIGN_EXTENSION
      Constant PARAM_VALUE_DESIGN_EXTENSION=".rptdesign"
      See Also:

    • PARAM_VALUE_XLSXREPORT_EXTENSION

      static final String PARAM_VALUE_XLSXREPORT_EXTENSION
      Constant PARAM_VALUE_XLSXREPORT_EXTENSION=".xlsx"
      See Also:

    • PARAM_VALUE_XMLREPORT_EXTENSION

      static final String PARAM_VALUE_XMLREPORT_EXTENSION
      Constant PARAM_VALUE_XMLREPORT_EXTENSION=".xml"
      See Also:

    • PARAM_VALUE_XLSMREPORT_EXTENSION

      static final String PARAM_VALUE_XLSMREPORT_EXTENSION
      Constant PARAM_VALUE_XLSMREPORT_EXTENSION=".xlsm"
      See Also:

  • Method Details

    • getSystemReportTemplates

      List<org.alfresco.service.cmr.repository.NodeRef> getSystemReportTemplates(ReportType reportType, org.alfresco.service.namespace.QName nodeType)
      Gets the system report templates.
      Parameters:
      nodeType - the system report templates
      reportType - a ReportType object.
      Returns:
      a List object.

    • getSystemReportTemplate

      org.alfresco.service.cmr.repository.NodeRef getSystemReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
      Gets the system report template.
      Parameters:
      reportType - a ReportType object.
      nodeType - a QName object.
      tplName - a String object.
      Returns:
      a NodeRef object.

    • getUserReportTemplate

      org.alfresco.service.cmr.repository.NodeRef getUserReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
      Get the user template by name
      Parameters:
      reportType - a ReportType object.
      nodeType - a QName object.
      tplName - a String object.
      Returns:
      a NodeRef object.

    • getUserReportTemplates

      List<org.alfresco.service.cmr.repository.NodeRef> getUserReportTemplates(ReportType reportType, org.alfresco.service.namespace.QName nodeType, String tplName)
      Gets the user report templates.
      Parameters:
      nodeType - the node type
      tplName - the tpl name the user report templates
      reportType - a ReportType object.
      Returns:
      a List object.

    • createTplRptDesign

      org.alfresco.service.cmr.repository.NodeRef createTplRptDesign(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, String tplName, String tplFilePath, ReportTplInformation tplInformation, boolean overrideTpl) throws IOException
      Create the rptdesign node for the report
      Parameters:
      parentNodeRef - a NodeRef object.
      tplName - a String object.
      tplFilePath - a String object.
      overrideTpl - a boolean.
      tplInformation - a ReportTplInformation object
      Returns:
      a NodeRef object.
      Throws:
      IOException - if any.

    • createTplRessource

      org.alfresco.service.cmr.repository.NodeRef createTplRessource(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, String xmlFilePath, boolean overrideRessource) throws IOException
      Create a resource for the report
      Parameters:
      parentNodeRef - a NodeRef object.
      xmlFilePath - a String object.
      overrideRessource - a boolean.
      Returns:
      a NodeRef object.
      Throws:
      IOException - if any.

    • cleanDefaultTpls

      List<org.alfresco.service.cmr.repository.NodeRef> cleanDefaultTpls(List<org.alfresco.service.cmr.repository.NodeRef> tplsNodeRef)
      Check the default reports (return one default tpl) if there is a user default tpl, remove system default tpl and keep user one
      Parameters:
      tplsNodeRef - a List object.
      Returns:
      a List object.

    • getReportFormat

      fr.becpg.report.client.ReportFormat getReportFormat(org.alfresco.service.cmr.repository.NodeRef tplNodeRef)
      Get the report format
      Parameters:
      tplNodeRef - a NodeRef object.
      Returns:
      a ReportFormat object.

    • getAssociatedReportTemplate

      org.alfresco.service.cmr.repository.NodeRef getAssociatedReportTemplate(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Get the template associated to the report
      Parameters:
      nodeRef - a NodeRef object.
      Returns:
      a NodeRef object.

    • getDefaultReportTemplate

      org.alfresco.service.cmr.repository.NodeRef getDefaultReportTemplate(ReportType reportType, org.alfresco.service.namespace.QName nodeType)

      getDefaultReportTemplate.

      Parameters:
      reportType - a ReportType object.
      nodeType - a QName object.
      Returns:
      a NodeRef object.