public interface

WebGridData

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

Class Overview

Represents grid data

Summary

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

Public Methods

public abstract WebCSSHelper getCSSHelper ()

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

Returns

public abstract String getErrorMsg ()

Returns String of error message comes from backend

Returns
  • String of error message

public abstract SimpleList getGraphAreas ()

public abstract int getGridTotalColumnBlocks ()

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

public abstract int getGridTotalRowBlocks ()

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

public abstract List<Integer> getMarkedRowIndices ()

Returns list of indices of marked rows (row ordinals)

Returns
  • List of marked rows

public abstract String getNoDataCustomMessage ()

public abstract WebReportGrid getWebReportGrid ()

Returns the report grid.

Returns
  • report grid
Throws
WebObjectsException thrown if a problem occurs during retrieval

public abstract boolean hasSubtotals ()

Indicates whether subtotals are added to the template

Returns
  • true if subtotals are added to the template

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

public abstract boolean isShowBanding ()

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