Package com.microstrategy.web.app.addons

Class RWSetFlagsAddOn

  • All Implemented Interfaces:
    AppAddOns
    public class RWSetFlagsAddOn
extends AbstractAppAddOn
    This add on takes care of setting the result flags specified on the view mode set for visualizations.
    The flags will only be set if visualizations are supported.
    If we are on the document page, the flags will only be set if we are in non-editable view mode.
    Since:
    MicroStrategy Web 8.0.2

    • Constructor Detail

      • RWSetFlagsAddOn

        public RWSetFlagsAddOn()

    • Method Detail

      • setBeanName

        public void setBeanName​(java.lang.String name)
        Sets the RW Bean name
        Parameters:
        name - bean name

      • setViewMode

        @Deprecated
public void setViewMode​(int viewMode)
        Deprecated.
        use setViewModeFlags(String)
        Sets the View Mode to set the flags for
        Parameters:
        viewMode - bean the View Mode to set the flags for

      • setResultFlags

        @Deprecated
public void setResultFlags​(int flags)
        Deprecated.
        use setViewModeFlags(String)
        Sets the result flags to set
        Parameters:
        flags - the result flags to set

      • setViewModeFlags

        public void setViewModeFlags​(java.lang.String vmFlags)
        Sets the result flags for specific view modes.
        The format must be:
        "viewMode:flags,viewMode2:flags2"
        Parameters:
        vmFlags -
        Since:
        MicroStrategy Web 8.1.2

      • setOptimizeForUseURLForVisualizationsPreference

        public void setOptimizeForUseURLForVisualizationsPreference​(boolean optimizeForUseURLForVisualizationsPreference)
        Whether to optimize flags if the useURLForVisualizations preference is true.
        The optimization removes the EnumDSSXMLResultFlags.DssXmlResultGrid result flag.
        Default is true.
        The optimization only applies to flags set at the document level.
        Parameters:
        optimizeForUseURLForVisualizationsPreference - whether to optimize flags if the useURLForVisualizations preference is true.
        .

      • 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.

      • 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)
        Since:
        MicroStrategy Web 9.0.3

      • setCurrentSelectedGridKey

        public void setCurrentSelectedGridKey​(java.lang.String gridKey)

      • setAdvThresholdEditorName

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