public interface

WebResultSettings

com.microstrategy.web.objects.WebResultSettings
Known Indirect Subclasses

Class Overview

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.

Summary

Constants
int EXPORT_MODE_DISABLED This constant is deprecated. since 8.0
int EXPORT_MODE_HTML This constant is deprecated. since 8.0
int EXPORT_MODE_PDF This constant is deprecated. since 8.0
Public Methods
abstract boolean getColumnWidthEnabled()
Returns the flag to indicate whether the result will include column width information.
abstract 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.
abstract boolean getEnhancedGraphXMLEnabled()
Retrieves a boolean indicating whether the extended graph properties are to be returned in the reportXML
abstract int getExportMode()
This method is deprecated. since 8.0
abstract boolean getImageMapsEnabled()
Returns a boolean indicating whether image maps are to be included in the XML.
abstract boolean getIncludeHeaderFooter()
Returns whether header and footer information will be brought back with report XML
abstract boolean getIncludeMetricUnitLimits()
Returns whether to bring back the metric unit limits XML
abstract boolean getIncludeObjectComments()
Returns whether internal object comments (long descriptions) will be retrieved.
abstract boolean getIncludeOnlyCurrentElementsInPageBy()
Returns whether only the current element will be brought back in pageBy XML
abstract boolean getIncludeThresholdDetails()
Reutnrs whether threshold details should be included in report XML
abstract boolean getIncludeViewFilterInTemplateNode()
Returns whether to include the view filter of a template in RW template node
abstract boolean getNoFormatInXMLEnabled()
Returns a boolean specifying whether formatting values should be omitted for grids.
abstract WebOptimizedDrillPathSettings getOptimizedDrillPathSettings()
Returns the settings interface to control the optimized drill paths in XML.
abstract boolean getRawDataEnabled()
Returns the flag about whether raw data retrieval is enabled.
abstract boolean getXDAHierarchies()
abstract boolean isPropertyOptimizationSet()
Indicates whether property optimization will be turned on
abstract void setColumnWidthEnabled(boolean enable)
Changes the current setting of whether to include the column width information in result.
abstract void setEnhancedGraphXMLEnabled(boolean enabled)
Enables retrieval of extended graph properties in the report xml.
abstract void setExportMode(int mode)
This method is deprecated. since 8.0
abstract void setFirstOrderPageTree(boolean firstOrderOnly)
abstract void setImageMapsEnabled(boolean useImageMaps)
Sets whether to include the image maps for graphs in the data that is returned.
abstract void setIncludeHeaderFooter(boolean includeHeaderFooter)
Configures whether the report XML should bring back header and footer information
abstract void setIncludeMetricUnitLimits(boolean includeMetricUnitLimits)
Configures whether the metric unit limits XML should be brought back
abstract void setIncludeObjectComments(boolean includeObjectComments)
Configures whether to retrieve internal object comments (long descriptions).
abstract void setIncludeOnlyCurrentElementsInPageBy(boolean includeOnlyCurrent)
Configures whether the report XML should bring back only current elements in the pageBy XML
abstract void setIncludeThresholdDetails(boolean includeThresholdDetails)
Configures whether the report XML should bring back threshold detail information
abstract void setIncludeViewFilterInTemplateNode(boolean includeViewFilterInTemplateNode)
Configures whether to include the view filter of a template in RW template node
abstract void setNewCssAndColumnHeader(boolean useNewCssAndColumnHeader)
Sets whether to omit formatting properties whose values are default in the CSS for grids.
abstract void setNoFormatInXMLEnabled(boolean value)
Sets a boolean specifying whether formatting information should be omitted for the grids.
abstract void setOptimizePropertiesInXML(boolean optimize)
This method is used to turn on optimizations in the properties returned as a part of the report xml.
abstract void setRawDataEnabled(boolean enable)
Sets the flag about whether raw data retrieval should be enabled.
abstract void setShowExpandedRowPage(boolean value)
Sets a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
abstract void setTerseElementIDs(boolean useTerse)
Configures whether to use terse element IDs.
abstract void setXDAHierarchies(boolean value)
abstract boolean showExpandedRowPage()
Returns a flag indicating that backend needs to return a page containing the last expanded/collapsed row.
abstract boolean useFirstOrderPageTree()
abstract 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.
abstract boolean useTerseElementIDs()
Returns whether to use terse element IDs.

Constants

public static final int EXPORT_MODE_DISABLED

This constant is deprecated.
since 8.0

Indicates that the current report instance is not being executed for export

Constant Value: 0 (0x00000000)

public static final int EXPORT_MODE_HTML

This constant is deprecated.
since 8.0

Indicates that the current execution is done for exporting and the mode of export is HTML

Constant Value: 2 (0x00000002)

public static final int EXPORT_MODE_PDF

This constant is deprecated.
since 8.0

Indicates that the current execution is done for exporting and the mode of export is PDF

Constant Value: 1 (0x00000001)

Public Methods

public abstract 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.

public abstract 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

public abstract boolean getEnhancedGraphXMLEnabled ()

Retrieves a boolean indicating whether the extended graph properties are to be returned in the reportXML

public abstract int getExportMode ()

This method is deprecated.
since 8.0

Returns
  • The current mode for export

public abstract boolean getImageMapsEnabled ()

Returns a boolean indicating whether image maps are to be included in the XML.

public abstract 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

public abstract boolean getIncludeMetricUnitLimits ()

Returns whether to bring back the metric unit limits XML

Returns
  • boolean specifying whether to include metric unit limits XML

public abstract boolean getIncludeObjectComments ()

Returns whether internal object comments (long descriptions) will be retrieved.

public abstract 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

public abstract boolean getIncludeThresholdDetails ()

Reutnrs whether threshold details should be included in report XML

Returns
  • true if report XML will include threahold information

public abstract 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

public abstract 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.

public abstract WebOptimizedDrillPathSettings getOptimizedDrillPathSettings ()

Returns the settings interface to control the optimized drill paths in XML.

public abstract 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 getRawValue() and getRawValue().

Returns
  • boolean True if raw data retrieval is enabled, otherwise false.

public abstract boolean getXDAHierarchies ()

public abstract boolean isPropertyOptimizationSet ()

Indicates whether property optimization will be turned on

Returns
  • boolean

public abstract 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.

public abstract void setEnhancedGraphXMLEnabled (boolean enabled)

Enables retrieval of extended graph properties in the report xml. This is turned off by default

public abstract void setExportMode (int mode)

This method is deprecated.
since 8.0

Sets the export mode to be one of the following constants

Parameters
mode indicates the mode

public abstract void setFirstOrderPageTree (boolean firstOrderOnly)

Parameters
firstOrderOnly whether to return data that has only the first order page-by options.

public abstract void setImageMapsEnabled (boolean useImageMaps)

Sets whether to include the image maps for graphs in the data that is returned.

public abstract 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

public abstract 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

public abstract void setIncludeObjectComments (boolean includeObjectComments)

Configures whether to retrieve internal object comments (long descriptions).

public abstract 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

public abstract 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

public abstract 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

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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 getRawValue() and getRawValue().

Parameters
enable boolean

public abstract void setShowExpandedRowPage (boolean value)

Sets a flag indicating that backend needs to return a page containing the last expanded/collapsed row.

public abstract void setTerseElementIDs (boolean useTerse)

Configures whether to use terse element IDs. This is intended to reduce the amount of data transmission.

public abstract void setXDAHierarchies (boolean value)

public abstract boolean showExpandedRowPage ()

Returns a flag indicating that backend needs to return a page containing the last expanded/collapsed row.

public abstract boolean useFirstOrderPageTree ()

Returns
  • whether to return data that has only the first order page-by options.

public abstract 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.

public abstract boolean useTerseElementIDs ()

Returns whether to use terse element IDs. This is intended to reduce the amount of data transmission.