Package com.microstrategy.web.objects

Interface WebGridData

All Known Subinterfaces:

WebReportData

public interface WebGridData

Represents grid data

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
WebCSSHelper	getCSSHelper()	Returns the WebCSSHelper object, which can be used to translate the format properties into css string.
java.lang.String	getErrorMsg()	Returns String of error message comes from backend
SimpleList	getGraphAreas()
int	getGridTotalColumnBlocks()
int	getGridTotalColumns()	Returns the total number of columns in this grid report.
int	getGridTotalRowBlocks()
int	getGridTotalRows()	Returns the total number of rows in this grid report.
java.util.List<java.lang.Integer>	getMarkedRowIndices()	Returns list of indices of marked rows (row ordinals)
java.lang.String	getNoDataCustomMessage()
WebReportGrid	getWebReportGrid()	Returns the report grid.
boolean	hasSubtotals()	Indicates whether subtotals are added to the template
boolean	isReportTruncated()	Returns whether or not this report is truncated.
boolean	isShowBanding()
boolean	isTotalAvailable()	Returns whether or not totals are available for this report.

Method Detail

getCSSHelper

WebCSSHelper getCSSHelper()

Returns the WebCSSHelper object, which can be used to translate the format properties into css string.

Returns:

The WebCSSHelper object for this report data.

getGridTotalColumns

int getGridTotalColumns()

Returns the total number of columns in this grid report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gdp/@tc".

Returns:

The total number of columns in this report or zero if the node is not available.

getGridTotalRows

int getGridTotalRows()

Returns the total number of rows in this grid report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gdp/@tr".

Returns:

The total number of columns in this report or zero if the node is not available.

getWebReportGrid

WebReportGrid getWebReportGrid()
                        throws WebObjectsException

Returns the report grid.

Returns:

report grid

Throws:

WebObjectsException - thrown if a problem occurs during retrieval

isReportTruncated

boolean isReportTruncated()

Returns whether or not this report is truncated. A truncated report would indicate that not all rows have been returned to in the result XML due to the window settings.

Returned from XSL search pattern: "/mi/rit/vw/gr/@xmn".

Returns:

True if the report is truncated.

isTotalAvailable

boolean isTotalAvailable()

Returns whether or not totals are available for this report.

Returned from XSL search pattern: "/mi/rit/vw/gr/@sr".

Returns:

True if the totals are available.

isShowBanding

boolean isShowBanding()
               throws WebObjectsException

Throws:

WebObjectsException

hasSubtotals

boolean hasSubtotals()
              throws WebObjectsException

Indicates whether subtotals are added to the template

Returns:

true if subtotals are added to the template

Throws:

WebObjectsException

getNoDataCustomMessage

java.lang.String getNoDataCustomMessage()

getGraphAreas

SimpleList getGraphAreas()
                  throws WebObjectsException

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

getMarkedRowIndices

java.util.List<java.lang.Integer> getMarkedRowIndices()

Returns list of indices of marked rows (row ordinals)

Returns:

List of marked rows

getGridTotalRowBlocks

int getGridTotalRowBlocks()

getGridTotalColumnBlocks

int getGridTotalColumnBlocks()

getErrorMsg

java.lang.String getErrorMsg()

Returns String of error message comes from backend

Returns:

String of error message