public interface

RWGridGraphSettings

implements WebResultSettings
com.microstrategy.web.objects.rw.RWGridGraphSettings

Class Overview

This interface exposes the result settings that can be set on a Grid/Graph in an RW document. This interface contains both the methods on WebResultSettings, plus the result flags to use for the grid(s). Note that the setEnabled method must be called in order for the settings on this interface to have any effect.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.WebResultSettings
Public Methods
abstract int getResultFlags()
Returns the current set of result flags that should be used.
abstract boolean getRetrieveMultipleRowsForGraphs()
This setting will return the property that signals to the Intelligence Server that all grid/graphs that are affected by this RWGridGraphSettings object should retrieve rows for the grid portion of the data using the regular method for determining the number of rows.
abstract boolean isEnabled()
Returns whether the values set on this interface will be used or not.
abstract void setEnabled(boolean enabled)
Sets whether the values set on this interface will be used in the GetExecutionResults call to the Intelligence Server when retrieving results.
abstract void setResultFlags(int resultFlags)
Sets the result flags that should be used when retrieving the data.
abstract void setRetrieveMultipleRowsForGraphs(boolean val)
This setting will set the property that signals to the Intelligence Server that all grid/graphs that are affected by this RWGridGraphSettings object should retrieve rows for the grid portion of the data using the regular method for determining the number of rows.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebResultSettings

Public Methods

public abstract int getResultFlags ()

Returns the current set of result flags that should be used. This should be the bitwise or of values in EnumDSSXMLResultFlags.

Returns
  • The current result flag setting.

public abstract boolean getRetrieveMultipleRowsForGraphs ()

This setting will return the property that signals to the Intelligence Server that all grid/graphs that are affected by this RWGridGraphSettings object should retrieve rows for the grid portion of the data using the regular method for determining the number of rows. This is to turn off the I-Server behavior of only returning a single row of data when the grid/graph is in graph mode.

Returns
  • The current setting of the retrieve all graph rows parameter.

public abstract boolean isEnabled ()

Returns whether the values set on this interface will be used or not.

Returns
  • True if the interface is active, false otherwise.

public abstract void setEnabled (boolean enabled)

Sets whether the values set on this interface will be used in the GetExecutionResults call to the Intelligence Server when retrieving results.

Parameters
enabled The new value of the enabled parameter.

public abstract void setResultFlags (int resultFlags)

Sets the result flags that should be used when retrieving the data. This should be the bitwise or of values in EnumDSSXMLResultFlags.

Parameters
resultFlags The new resultFlags setting.

public abstract void setRetrieveMultipleRowsForGraphs (boolean val)

This setting will set the property that signals to the Intelligence Server that all grid/graphs that are affected by this RWGridGraphSettings object should retrieve rows for the grid portion of the data using the regular method for determining the number of rows. This is to turn off the I-Server behavior of only returning a single row of data when the grid/graph is in graph mode.

Parameters
val The new value of the setting.