Package com.microstrategy.web.objects

Class WebResultSettingsImpl

    • Method Detail

      • getEnhancedGraphXMLEnabled

        public boolean getEnhancedGraphXMLEnabled()
        Description copied from interface: WebResultSettings
        Retrieves a boolean indicating whether the extended graph properties are to be returned in the reportXML
        Specified by:
        getEnhancedGraphXMLEnabled in interface WebResultSettings
        Since:
        MicroStrategy Web 8.0.2

      • setEnhancedGraphXMLEnabled

        public void setEnhancedGraphXMLEnabled​(boolean enabled)
        Description copied from interface: WebResultSettings
        Enables retrieval of extended graph properties in the report xml. This is turned off by default
        Specified by:
        setEnhancedGraphXMLEnabled in interface WebResultSettings
        Since:
        MicroStrategy Web 8.0.2

      • getColumnWidthEnabled

        public boolean getColumnWidthEnabled()
        Description copied from interface: WebResultSettings
        Returns the flag to indicate whether the result will include column width information.
        Specified by:
        getColumnWidthEnabled in interface WebResultSettings
        Returns:
        Return current setting of this flag. true for including the column width information in result; otherwise, false.

      • setColumnWidthEnabled

        public void setColumnWidthEnabled​(boolean enable)
        Description copied from interface: WebResultSettings
        Changes the current setting of whether to include the column width information in result.
        Specified by:
        setColumnWidthEnabled in interface WebResultSettings
        Parameters:
        enable - true to include the column width information. false to not include it.

      • getRawDataEnabled

        public boolean getRawDataEnabled()
        Description copied from interface: WebResultSettings
        Returns the flag about whether raw data retrieval is enabled. When raw data retrieval is enabled, the unformatted data and raw dates (a double number) will be returned from backend. Those raw data can be accessed from WebRowValue.getRawValue() and WebHeader.getRawValue().
        Specified by:
        getRawDataEnabled in interface WebResultSettings
        Returns:
        boolean True if raw data retrieval is enabled, otherwise false.
        Since:
        MicroStrategy Web 7.5.4

      • setRawDataEnabled

        public void setRawDataEnabled​(boolean enable)
        Description copied from interface: WebResultSettings
        Sets the flag about whether raw data retrieval should be enabled. When raw data retrieval is enabled, the unformatted data and raw dates (a double number) will be returned from backend. Those raw data can be accessed from WebRowValue.getRawValue() and WebHeader.getRawValue().
        Specified by:
        setRawDataEnabled in interface WebResultSettings
        Parameters:
        enable - boolean
        Since:
        MicroStrategy Web 7.5.4

      • isPropertyOptimizationSet

        public boolean isPropertyOptimizationSet()
        Description copied from interface: WebResultSettings
        Indicates whether property optimization will be turned on
        Specified by:
        isPropertyOptimizationSet in interface WebResultSettings
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.0.0

      • setOptimizePropertiesInXML

        public void setOptimizePropertiesInXML​(boolean optimize)
        Description copied from interface: WebResultSettings
        This method is used to turn on optimizations in the properties returned as a part of the report xml. This is turned off by default in order to maintain backward compatibility. It is recommended that this property be set before using any report functionality because it reduces the size of the xml that is transferred from the intelligence server.
        Specified by:
        setOptimizePropertiesInXML in interface WebResultSettings
        Since:
        MicroStrategy Web 8.0.0

      • getImageMapsEnabled

        public boolean getImageMapsEnabled()
        Description copied from interface: WebResultSettings
        Returns a boolean indicating whether image maps are to be included in the XML.
        Specified by:
        getImageMapsEnabled in interface WebResultSettings
        Since:
        MicroStrategy Web 8.1.0

      • setNewCssAndColumnHeader

        public void setNewCssAndColumnHeader​(boolean useNewCssAndColumnHeader)
        Description copied from interface: WebResultSettings
        Sets whether to omit formatting properties whose values are default in the CSS for grids. Also sets whether to omit the column titles as part of the column headers node.
        Specified by:
        setNewCssAndColumnHeader in interface WebResultSettings
        Since:
        MicroStrategy Web 9.0.0

      • useNewCssAndColumnHeader

        public boolean useNewCssAndColumnHeader()
        Description copied from interface: WebResultSettings
        Returns whether default formatting properties are omitted in the CSS for grids and also whether column titles are omitted as part of the column headers.
        Specified by:
        useNewCssAndColumnHeader in interface WebResultSettings
        Since:
        MicroStrategy Web 9.0.0

      • getNoFormatInXMLEnabled

        public boolean getNoFormatInXMLEnabled()
        Description copied from interface: WebResultSettings
        Returns a boolean specifying whether formatting values should be omitted for grids.
        Specified by:
        getNoFormatInXMLEnabled in interface WebResultSettings
        Returns:
        a boolean true if formatting information is skipped for grids otherwise returns false.
        Since:
        MicroStrategy Web 9.0.0

      • setNoFormatInXMLEnabled

        public void setNoFormatInXMLEnabled​(boolean value)
        Description copied from interface: WebResultSettings
        Sets a boolean specifying whether formatting information should be omitted for the grids.
        Specified by:
        setNoFormatInXMLEnabled in interface WebResultSettings
        Parameters:
        value - boolean true if formatting information is skipped for grids otherwise set it to false.
        Since:
        MicroStrategy Web 9.0.0

      • useTerseElementIDs

        public boolean useTerseElementIDs()
        Description copied from interface: WebResultSettings
        Returns whether to use terse element IDs. This is intended to reduce the amount of data transmission.
        Specified by:
        useTerseElementIDs in interface WebResultSettings

      • setTerseElementIDs

        public void setTerseElementIDs​(boolean useTerse)
        Description copied from interface: WebResultSettings
        Configures whether to use terse element IDs. This is intended to reduce the amount of data transmission.
        Specified by:
        setTerseElementIDs in interface WebResultSettings

      • setIncludeObjectComments

        public void setIncludeObjectComments​(boolean includeObjectComments)
        Description copied from interface: WebResultSettings
        Configures whether to retrieve internal object comments (long descriptions).
        Specified by:
        setIncludeObjectComments in interface WebResultSettings

      • getIncludeHeaderFooter

        public boolean getIncludeHeaderFooter()
        Description copied from interface: WebResultSettings
        Returns whether header and footer information will be brought back with report XML
        Specified by:
        getIncludeHeaderFooter in interface WebResultSettings
        Returns:
        true if report XML will include header/footer information

      • setIncludeHeaderFooter

        public void setIncludeHeaderFooter​(boolean includeHeaderFooter)
        Description copied from interface: WebResultSettings
        Configures whether the report XML should bring back header and footer information
        Specified by:
        setIncludeHeaderFooter in interface WebResultSettings
        Parameters:
        includeHeaderFooter - boolean specifying true if report XML should contain header/footer info

      • getIncludeThresholdDetails

        public boolean getIncludeThresholdDetails()
        Description copied from interface: WebResultSettings
        Reutnrs whether threshold details should be included in report XML
        Specified by:
        getIncludeThresholdDetails in interface WebResultSettings
        Returns:
        true if report XML will include threahold information

      • setIncludeThresholdDetails

        public void setIncludeThresholdDetails​(boolean includeThresholdDetails)
        Description copied from interface: WebResultSettings
        Configures whether the report XML should bring back threshold detail information
        Specified by:
        setIncludeThresholdDetails in interface WebResultSettings
        Parameters:
        includeThresholdDetails - boolean specifying true if report XML should contain threshold details

      • getIncludeOnlyCurrentElementsInPageBy

        public boolean getIncludeOnlyCurrentElementsInPageBy()
        Description copied from interface: WebResultSettings
        Returns whether only the current element will be brought back in pageBy XML
        Specified by:
        getIncludeOnlyCurrentElementsInPageBy in interface WebResultSettings
        Returns:
        boolean specifying whether only current elements will be included

      • setIncludeOnlyCurrentElementsInPageBy

        public void setIncludeOnlyCurrentElementsInPageBy​(boolean includeOnlyCurrent)
        Description copied from interface: WebResultSettings
        Configures whether the report XML should bring back only current elements in the pageBy XML
        Specified by:
        setIncludeOnlyCurrentElementsInPageBy in interface WebResultSettings
        Parameters:
        includeOnlyCurrent - boolean specifying whether to only include current elements

      • showExpandedRowPage

        public boolean showExpandedRowPage()
        Description copied from interface: WebResultSettings
        Returns a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
        Specified by:
        showExpandedRowPage in interface WebResultSettings

      • setShowExpandedRowPage

        public void setShowExpandedRowPage​(boolean value)
        Description copied from interface: WebResultSettings
        Sets a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
        Specified by:
        setShowExpandedRowPage in interface WebResultSettings

      • getIncludeMetricUnitLimits

        public boolean getIncludeMetricUnitLimits()
        Description copied from interface: WebResultSettings
        Returns whether to bring back the metric unit limits XML
        Specified by:
        getIncludeMetricUnitLimits in interface WebResultSettings
        Returns:
        boolean specifying whether to include metric unit limits XML

      • setIncludeMetricUnitLimits

        public void setIncludeMetricUnitLimits​(boolean includeMetricUnitLimits)
        Description copied from interface: WebResultSettings
        Configures whether the metric unit limits XML should be brought back
        Specified by:
        setIncludeMetricUnitLimits in interface WebResultSettings
        Parameters:
        includeMetricUnitLimits - boolean specifying whether to include metric unit limits XML

      • getIncludeViewFilterInTemplateNode

        public boolean getIncludeViewFilterInTemplateNode()
        Description copied from interface: WebResultSettings
        Returns whether to include the view filter of a template in RW template node
        Specified by:
        getIncludeViewFilterInTemplateNode in interface WebResultSettings
        Returns:
        boolean specifying whether to include view filter on template node

      • setIncludeViewFilterInTemplateNode

        public void setIncludeViewFilterInTemplateNode​(boolean includeViewFilterInTemplateNode)
        Description copied from interface: WebResultSettings
        Configures whether to include the view filter of a template in RW template node
        Specified by:
        setIncludeViewFilterInTemplateNode in interface WebResultSettings
        Parameters:
        includeViewFilterInTemplateNode - boolean specifying whether to include view filter on template node