public class

WebResultSettingsImpl

extends Object
implements WebResultSettings
java.lang.Object
   ↳ com.microstrategy.web.objects.WebResultSettingsImpl

Summary

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

Public Methods

public 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 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 boolean getEnhancedGraphXMLEnabled ()

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

public int getExportMode ()

public boolean getImageMapsEnabled ()

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

public 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 boolean getIncludeMetricUnitLimits ()

Returns whether to bring back the metric unit limits XML

Returns
  • boolean specifying whether to include metric unit limits XML

public boolean getIncludeObjectComments ()

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

public 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 boolean getIncludeThresholdDetails ()

Reutnrs whether threshold details should be included in report XML

Returns
  • true if report XML will include threahold information

public 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 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 WebOptimizedDrillPathSettings getOptimizedDrillPathSettings ()

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

public 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 boolean getXDAHierarchies ()

public boolean isPropertyOptimizationSet ()

Indicates whether property optimization will be turned on

Returns
  • boolean

public 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 void setEnhancedGraphXMLEnabled (boolean enabled)

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

public void setExportMode (int mode)

Sets the export mode to be one of the following constants

Parameters
mode indicates the mode

public void setFirstOrderPageTree (boolean firstOrderOnly)

public void setImageMapsEnabled (boolean useImageMaps)

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

public 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 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 void setIncludeObjectComments (boolean includeObjectComments)

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

public 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 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 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 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 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 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 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 void setShowExpandedRowPage (boolean value)

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

public void setTerseElementIDs (boolean useTerse)

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

public void setXDAHierarchies (boolean value)

public boolean showExpandedRowPage ()

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

public boolean useFirstOrderPageTree ()

public 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 boolean useTerseElementIDs ()

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