Package org.apache.ofbiz.birt.flexible

Class BirtServices

  • public class BirtServices
extends java.lang.Object
    Birt Services

    • Constructor Summary

      Constructors 
      Constructor Description
      BirtServices()  

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.util.Map<java.lang.String,​java.lang.Object> callPerformFindFromBirt​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Perform find data on given view/entity and return these into Birt compatible format.
      static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReport​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Instantiate a new Flexible report, using the data given in parameters and ReportDesignGenerator class.
      static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMaster​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Analyse given master and create report design from its data Two cases are implemented : Entity : data retieval is based on a simple view/entity Service : data retrieval is based on service
      static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMasterEntityWorkflow​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Create report design from View/Entity master report
      static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMasterServiceWorkflow​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Create report design from service master report
      static java.util.Map<java.lang.String,​java.lang.Object> createFormForDisplay​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Prepare and return search form of a report design
      static java.util.Map<java.lang.String,​java.lang.Object> deleteAllReports​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      delete all non-master report design, not used OOTB but accessible as service
      static java.util.Map<java.lang.String,​java.lang.Object> deleteFlexibleReport​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Delete a flexible report design
      static java.util.Map<java.lang.String,​java.lang.Object> overrideReportForm​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Update search form of a report design
      static java.util.Map<java.lang.String,​java.lang.Object> prepareFlexibleReportFieldsFromEntity​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Define which data fields and its label, filter fields and label that will be supported by the View/Entity report design
      static java.util.Map<java.lang.String,​java.lang.Object> prepareFlexibleReportOptionFieldsFromEntity​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Deprecated.
      static java.util.Map<java.lang.String,​java.lang.Object> uploadRptDesign​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Update birt rptdesign file from uploaded one.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • module

        public static final java.lang.String module

    • Constructor Detail

      • BirtServices

        public BirtServices()

    • Method Detail

      • createFlexibleReport

        public static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReport​(DispatchContext dctx,
                                                                                          java.util.Map<java.lang.String,​java.lang.Object> context)
        Instantiate a new Flexible report, using the data given in parameters and ReportDesignGenerator class.

      • prepareFlexibleReportOptionFieldsFromEntity

        @Deprecated
public static java.util.Map<java.lang.String,​java.lang.Object> prepareFlexibleReportOptionFieldsFromEntity​(DispatchContext dctx,
                                                                                                                 java.util.Map<java.lang.String,​java.lang.Object> context)
        Deprecated.

      • callPerformFindFromBirt

        public static java.util.Map<java.lang.String,​java.lang.Object> callPerformFindFromBirt​(DispatchContext dctx,
                                                                                             java.util.Map<java.lang.String,​java.lang.Object> context)
        Perform find data on given view/entity and return these into Birt compatible format. This service is meant to be used as default for View/entity report design

      • createFlexibleReportFromMaster

        public static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMaster​(DispatchContext dctx,
                                                                                                    java.util.Map<java.lang.String,​java.lang.Object> context)
        Analyse given master and create report design from its data Two cases are implemented :
        • Entity : data retieval is based on a simple view/entity
        • Service : data retrieval is based on service

      • overrideReportForm

        public static java.util.Map<java.lang.String,​java.lang.Object> overrideReportForm​(DispatchContext dctx,
                                                                                        java.util.Map<java.lang.String,​java.lang.Object> context)
        Update search form of a report design

      • createFlexibleReportFromMasterEntityWorkflow

        public static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMasterEntityWorkflow​(DispatchContext dctx,
                                                                                                                  java.util.Map<java.lang.String,​java.lang.Object> context)
        Create report design from View/Entity master report

      • createFlexibleReportFromMasterServiceWorkflow

        public static java.util.Map<java.lang.String,​java.lang.Object> createFlexibleReportFromMasterServiceWorkflow​(DispatchContext dctx,
                                                                                                                   java.util.Map<java.lang.String,​java.lang.Object> context)
        Create report design from service master report

      • prepareFlexibleReportFieldsFromEntity

        public static java.util.Map<java.lang.String,​java.lang.Object> prepareFlexibleReportFieldsFromEntity​(DispatchContext dctx,
                                                                                                           java.util.Map<java.lang.String,​java.lang.Object> context)
        Define which data fields and its label, filter fields and label that will be supported by the View/Entity report design

      • createFormForDisplay

        public static java.util.Map<java.lang.String,​java.lang.Object> createFormForDisplay​(DispatchContext dctx,
                                                                                          java.util.Map<java.lang.String,​java.lang.Object> context)
        Prepare and return search form of a report design

      • deleteAllReports

        public static java.util.Map<java.lang.String,​java.lang.Object> deleteAllReports​(DispatchContext dctx,
                                                                                      java.util.Map<java.lang.String,​java.lang.Object> context)
        delete all non-master report design, not used OOTB but accessible as service

      • deleteFlexibleReport

        public static java.util.Map<java.lang.String,​java.lang.Object> deleteFlexibleReport​(DispatchContext dctx,
                                                                                          java.util.Map<java.lang.String,​java.lang.Object> context)
        Delete a flexible report design

      • uploadRptDesign

        public static java.util.Map<java.lang.String,​java.lang.Object> uploadRptDesign​(DispatchContext dctx,
                                                                                     java.util.Map<java.lang.String,​java.lang.Object> context)
        Update birt rptdesign file from uploaded one.

        This will update only STYLES, BODY, MASTERPAGE AND CUBES from existing rptdesign with uploaded ones.