Interface WebResultSettings

  • All Known Subinterfaces:
    RWGridGraphSettings
    All Known Implementing Classes:
    WebResultSettingsImpl

    public interface WebResultSettings
    This is the interface for the extendable parameters, which is an extension of the original result flags. User could use this interface and result flags to indicate which kind of information to retrieve from server.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • getColumnWidthEnabled

        boolean getColumnWidthEnabled()
        Returns the flag to indicate whether the result will include column width information.
        Returns:
        Return current setting of this flag. true for including the column width information in result; otherwise, false.
      • setColumnWidthEnabled

        void setColumnWidthEnabled​(boolean enable)
        Changes the current setting of whether to include the column width information in result.
        Parameters:
        enable - true to include the column width information. false to not include it.
      • getRawDataEnabled

        boolean getRawDataEnabled()
        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().
        Returns:
        boolean True if raw data retrieval is enabled, otherwise false.
        Since:
        MicroStrategy Web 7.5.4
      • setRawDataEnabled

        void setRawDataEnabled​(boolean enable)
        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().
        Parameters:
        enable - boolean
        Since:
        MicroStrategy Web 7.5.4
      • setOptimizePropertiesInXML

        void setOptimizePropertiesInXML​(boolean optimize)
        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.
        Since:
        MicroStrategy Web 8.0.0
      • isPropertyOptimizationSet

        boolean isPropertyOptimizationSet()
        Indicates whether property optimization will be turned on
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.0.0
      • getOptimizedDrillPathSettings

        WebOptimizedDrillPathSettings getOptimizedDrillPathSettings()
        Returns the settings interface to control the optimized drill paths in XML.
        Since:
        MicroStrategy Web 8.0.0
      • setXDAHierarchies

        void setXDAHierarchies​(boolean value)
        Since:
        MicroStrategy Web 8.0.2
      • getXDAHierarchies

        boolean getXDAHierarchies()
        Since:
        MicroStrategy Web 8.0.2
      • setEnhancedGraphXMLEnabled

        void setEnhancedGraphXMLEnabled​(boolean enabled)
        Enables retrieval of extended graph properties in the report xml. This is turned off by default
        Parameters:
        enabled -
        Since:
        MicroStrategy Web 8.0.2
      • getEnhancedGraphXMLEnabled

        boolean getEnhancedGraphXMLEnabled()
        Retrieves a boolean indicating whether the extended graph properties are to be returned in the reportXML
        Since:
        MicroStrategy Web 8.0.2
      • setFirstOrderPageTree

        void setFirstOrderPageTree​(boolean firstOrderOnly)
        Parameters:
        firstOrderOnly - whether to return data that has only the first order page-by options.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        EnumDSSXMLResult2Flags.DssXmlResult2PageTreeStyle2
      • setImageMapsEnabled

        void setImageMapsEnabled​(boolean useImageMaps)
        Sets whether to include the image maps for graphs in the data that is returned.
        Parameters:
        useImageMaps -
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        EnumDSSXMLResult2Flags.DssXmlResult2ImageMap
      • getImageMapsEnabled

        boolean getImageMapsEnabled()
        Returns a boolean indicating whether image maps are to be included in the XML.
        Since:
        MicroStrategy Web 8.1.0
      • getDetailsFormatter

        WebDetailsFormatter getDetailsFormatter()
        Returns a WebDetailsFormatter object using which we can set the format for the template details, prompt details, filter details etc that are generated on the IServer. These details can then be read from WebReportData
        Since:
        MicroStrategy Web 9.0.0
      • setNewCssAndColumnHeader

        void setNewCssAndColumnHeader​(boolean useNewCssAndColumnHeader)
        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.
        Parameters:
        useNewCssAndColumnHeader -
        Since:
        MicroStrategy Web 9.0.0
      • useNewCssAndColumnHeader

        boolean useNewCssAndColumnHeader()
        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.
        Since:
        MicroStrategy Web 9.0.0
      • setNoFormatInXMLEnabled

        void setNoFormatInXMLEnabled​(boolean value)
        Sets a boolean specifying whether formatting information should be omitted for the grids.
        Parameters:
        value - boolean true if formatting information is skipped for grids otherwise set it to false.
        Since:
        MicroStrategy Web 9.0.0
      • getNoFormatInXMLEnabled

        boolean getNoFormatInXMLEnabled()
        Returns a boolean specifying whether formatting values should be omitted for grids.
        Returns:
        a boolean true if formatting information is skipped for grids otherwise returns false.
        Since:
        MicroStrategy Web 9.0.0
      • setTerseElementIDs

        void setTerseElementIDs​(boolean useTerse)
        Configures whether to use terse element IDs. This is intended to reduce the amount of data transmission.
      • useTerseElementIDs

        boolean useTerseElementIDs()
        Returns whether to use terse element IDs. This is intended to reduce the amount of data transmission.
      • setIncludeObjectComments

        void setIncludeObjectComments​(boolean includeObjectComments)
        Configures whether to retrieve internal object comments (long descriptions).
      • getIncludeObjectComments

        boolean getIncludeObjectComments()
        Returns whether internal object comments (long descriptions) will be retrieved.
      • setIncludeHeaderFooter

        void setIncludeHeaderFooter​(boolean includeHeaderFooter)
        Configures whether the report XML should bring back header and footer information
        Parameters:
        includeHeaderFooter - boolean specifying true if report XML should contain header/footer info
      • getIncludeHeaderFooter

        boolean getIncludeHeaderFooter()
        Returns whether header and footer information will be brought back with report XML
        Returns:
        true if report XML will include header/footer information
      • setIncludeThresholdDetails

        void setIncludeThresholdDetails​(boolean includeThresholdDetails)
        Configures whether the report XML should bring back threshold detail information
        Parameters:
        includeThresholdDetails - boolean specifying true if report XML should contain threshold details
      • getIncludeThresholdDetails

        boolean getIncludeThresholdDetails()
        Reutnrs whether threshold details should be included in report XML
        Returns:
        true if report XML will include threahold information
      • setIncludeOnlyCurrentElementsInPageBy

        void setIncludeOnlyCurrentElementsInPageBy​(boolean includeOnlyCurrent)
        Configures whether the report XML should bring back only current elements in the pageBy XML
        Parameters:
        includeOnlyCurrent - boolean specifying whether to only include current elements
      • getIncludeOnlyCurrentElementsInPageBy

        boolean getIncludeOnlyCurrentElementsInPageBy()
        Returns whether only the current element will be brought back in pageBy XML
        Returns:
        boolean specifying whether only current elements will be included
      • setShowExpandedRowPage

        void setShowExpandedRowPage​(boolean value)
        Sets a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
        Parameters:
        value -
      • showExpandedRowPage

        boolean showExpandedRowPage()
        Returns a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
      • setIncludeMetricUnitLimits

        void setIncludeMetricUnitLimits​(boolean includeMetricUnitLimits)
        Configures whether the metric unit limits XML should be brought back
        Parameters:
        includeMetricUnitLimits - boolean specifying whether to include metric unit limits XML
      • getIncludeMetricUnitLimits

        boolean getIncludeMetricUnitLimits()
        Returns whether to bring back the metric unit limits XML
        Returns:
        boolean specifying whether to include metric unit limits XML
      • setIncludeViewFilterInTemplateNode

        void setIncludeViewFilterInTemplateNode​(boolean includeViewFilterInTemplateNode)
        Configures whether to include the view filter of a template in RW template node
        Parameters:
        includeViewFilterInTemplateNode - boolean specifying whether to include view filter on template node
      • getIncludeViewFilterInTemplateNode

        boolean getIncludeViewFilterInTemplateNode()
        Returns whether to include the view filter of a template in RW template node
        Returns:
        boolean specifying whether to include view filter on template node