Package com.microstrategy.web.app.addons

Class ReportSetFlagsAddOn

  • All Implemented Interfaces:
    AppAddOns
    public class ReportSetFlagsAddOn
extends AbstractAppAddOn

    Title: ReportSetFlagsAddOn.

    Description: This add on takes care of setting the required result flags on the report bean. This add on acts on all the report beans on a page.

    Copyright: Copyright (c) 2002

    Company: Microstrategy, Inc.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Constructor Detail

      • ReportSetFlagsAddOn

        public ReportSetFlagsAddOn()

    • Method Detail

      • optimizeFlags

        protected void optimizeFlags​(ReportBean rb)
        optimizes the result and execution flags found in the eventOptimizationFlags.xml
        Parameters:
        rb - ReportBean
        Since:
        MicroStrategy Web 8.0.0

      • optimizeEvent

        protected void optimizeEvent​(ReportBean rb,
                             EventFlagList eventInfo)
        optimizes the result and execution flags found in the eventOptimizationFlags.xml
        Parameters:
        rb - ReportBean
        eventInfo - EventFlagList
        Since:
        MicroStrategy Web 8.0.0

      • getAddOnDescription

        public java.lang.String getAddOnDescription()
        Description copied from interface: AppAddOns
        This method describes the tasks performed by the AddOn.
        Returns:
        The tasks which the Add On performs. This needs to be as descriptive as possible.
        See Also:
        AppAddOns.getAddOnDescription()

      • setReportResultFlags

        protected static void setReportResultFlags​(ReportBean rb,
                                           Preferences prefs,
                                           boolean includeThresholdDef)
                                    throws WebBeanException
        Sets the result flags on the report bean.
        Parameters:
        rb - the report bean
        prefs - The Preferences object
        includeThresholdDetails - Do we need the threshold definition from backend, true, we need, false, we don't
        Throws:
        WebBeanException

      • setAddToInbox

        protected static void setAddToInbox​(ReportBean rb,
                                    Preferences prefs)
        This method sets the saveToInbox on the report bean.
        Parameters:
        rb - the report bean
        prefs - The Preferences object

      • addToInboxAfterCollectData

        protected static void addToInboxAfterCollectData​(ReportBean rb,
                                                 Preferences prefs,
                                                 RequestKeys keys)
        This method adds the report to the history list only when the user clicks on the execute button if the AddToInboxBeforeCollectData is false.
        Parameters:
        rb - the report bean
        prefs - The Preferences object
        keys - The request keys
        Since:
        MicroStrategy Web 7.5.4

      • isDesignMode

        public static boolean isDesignMode​(ReportBean rb)
        This method checks whether it's design mode.
        Parameters:
        rb - the report bean
        Returns:
        boolean true if in design mode

      • isCreateMode

        public static boolean isCreateMode​(ReportBean rb)
        This method checks whether it's create mode.
        Parameters:
        rb - the report bean
        Returns:
        boolean true if in create mode

      • isExecuteMode

        public static boolean isExecuteMode​(ReportBean rb)
        This method checks whether it's execute mode
        Parameters:
        rb - the report bean
        Returns:
        boolean true if in execute mode
        Since:
        MicroStrategy Web 7.5.4

      • setPromptCreateReportStyle

        public void setPromptCreateReportStyle​(java.lang.String value)
        Sets the name of the PromptCreateReportStyle
        Parameters:
        value - name of the PromptCreateReportStyle
        Since:
        MicroStrategy Web 7.5.1

      • setAddToInboxBeforeCollectData

        public void setAddToInboxBeforeCollectData​(boolean value)
        Set to true if we want to add the message automatically to inbox before the collect data. If this value is set to false we will add the message automatically to inbox after the collect data only when the user chooses to view the report data. In that case the history list will never have reports which are waiting for user input (i.e: Prompted state)
        Parameters:
        value - true if we want to add the message automatically to inbox before the collect data.
        Since:
        MicroStrategy Web 7.5.4

      • setEventOptimizationFile

        public void setEventOptimizationFile​(java.lang.String value)
        Sets the location of the event based flag optimization definition file
        Parameters:
        value - name of the eventOptimizationFile
        Since:
        MicroStrategy Web 8.0.0

      • setUseTerseElementIDs

        public void setUseTerseElementIDs​(boolean useTerse)
        Since:
        MicroStrategy Web 9.0.1

      • getUseTerseElementIDs

        public boolean getUseTerseElementIDs()
        Since:
        MicroStrategy Web 9.0.1

      • setVisThresholdEditorName

        public void setVisThresholdEditorName​(java.lang.String visThresholdEditorName)

      • setAdvThresholdEditorName

        public void setAdvThresholdEditorName​(java.lang.String advThresholdEditorName)

      • setEmailAlertEditorName

        public void setEmailAlertEditorName​(java.lang.String emailAlertEditorName)

      • setMobileAlertEditorName

        public void setMobileAlertEditorName​(java.lang.String mobileAlertEditorName)