Package com.microstrategy.web.objects.rw
Interface RWGridGraphSettings
-
- All Superinterfaces:
WebResultSettings
public interface RWGridGraphSettings extends WebResultSettings
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.- Since:
- MicroStrategy Web 8.0.2
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.objects.WebResultSettings
EXPORT_MODE_DISABLED, EXPORT_MODE_HTML, EXPORT_MODE_PDF
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getResultFlags()
Returns the current set of result flags that should be used.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.boolean
isEnabled()
Returns whether the values set on this interface will be used or not.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.void
setResultFlags(int resultFlags)
Sets the result flags that should be used when retrieving the data.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.-
Methods inherited from interface com.microstrategy.web.objects.WebResultSettings
getColumnWidthEnabled, getDetailsFormatter, getEnhancedGraphXMLEnabled, getExportMode, getImageMapsEnabled, getIncludeHeaderFooter, getIncludeMetricUnitLimits, getIncludeObjectComments, getIncludeOnlyCurrentElementsInPageBy, getIncludeThresholdDetails, getIncludeViewFilterInTemplateNode, getNoFormatInXMLEnabled, getOptimizedDrillPathSettings, getRawDataEnabled, getXDAHierarchies, isPropertyOptimizationSet, setColumnWidthEnabled, setEnhancedGraphXMLEnabled, setExportMode, setFirstOrderPageTree, setImageMapsEnabled, setIncludeHeaderFooter, setIncludeMetricUnitLimits, setIncludeObjectComments, setIncludeOnlyCurrentElementsInPageBy, setIncludeThresholdDetails, setIncludeViewFilterInTemplateNode, setNewCssAndColumnHeader, setNoFormatInXMLEnabled, setOptimizePropertiesInXML, setRawDataEnabled, setShowExpandedRowPage, setTerseElementIDs, setXDAHierarchies, showExpandedRowPage, useFirstOrderPageTree, useNewCssAndColumnHeader, useTerseElementIDs
-
-
-
-
Method Detail
-
isEnabled
boolean isEnabled()
Returns whether the values set on this interface will be used or not.- Returns:
- True if the interface is active, false otherwise.
-
setEnabled
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.
-
getResultFlags
int getResultFlags()
Returns the current set of result flags that should be used. This should be the bitwise or of values inEnumDSSXMLResultFlags
.- Returns:
- The current result flag setting.
-
setResultFlags
void setResultFlags(int resultFlags)
Sets the result flags that should be used when retrieving the data. This should be the bitwise or of values inEnumDSSXMLResultFlags
.- Parameters:
resultFlags
- The new resultFlags setting.
-
getRetrieveMultipleRowsForGraphs
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.
-
setRetrieveMultipleRowsForGraphs
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.
-
-