public interface

WebRowValue

implements WebCssFormatContainer WebTransactableDataObject
com.microstrategy.web.objects.WebRowValue

Class Overview

This interface provides accessor methods to obtain the various properties associated with a metric value.

Summary

Public Methods
abstract String getCcl()
Returns the cell color.
abstract WebHeader getColumnHeader()
Returns the corresponding column-axis WebHeader at the finest granularity associated with the this WebRowValue.
abstract WebHeader getColumnHeader(int enumWebHeaderType)
Returns the corresponding column-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.
abstract WebRow getContainer()
abstract WebDrillMap getDrillMap()
Returns the drill map assigned to the template.
abstract int getOrdinal()
abstract String getRawValue()
Returns the raw data value of this row value.
abstract WebHeader getRowHeader()
Returns the corresponding row-axis WebHeader at the finest granularity associated with the this WebRowValue.
abstract WebHeader getRowHeader(int enumWebHeaderType)
Returns the corresponding row-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.
abstract int getSemantics()
The meaning of this form value.
abstract WebTitle getSubtotalTitle()
This method will return the WebTitle corresponding to the 'Subtotal' WebHeader, if this is subtotal value, otherwise null will be returned.
abstract int getTransactionAction()
return thresholdAction EnumDSSXMLTransactionAction
abstract int getType()
abstract String getValue()
abstract boolean isEditDisable()
Returns the unit can be edit or not.
abstract boolean isFirst()
abstract boolean isLast()
abstract void setTransactionAction(int action)
set thresholdAction EnumDSSXMLTransactionAction
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebCssFormatContainer
From interface com.microstrategy.web.objects.WebTransactableDataObject

Public Methods

public abstract String getCcl ()

Returns the cell color. Only used by legacy applications.

Returns
  • the cell color.

public abstract WebHeader getColumnHeader ()

Returns the corresponding column-axis WebHeader at the finest granularity associated with the this WebRowValue. This only makes sense for metric row values. Null is returned for subtotals, or if no associated header is found.

Returns
  • the corresponding column-axis WebHeader

public abstract WebHeader getColumnHeader (int enumWebHeaderType)

Returns the corresponding column-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.

Returns
  • the corresponding column-axis WebHeader of specified type.

public abstract WebRow getContainer ()

Returns

public abstract WebDrillMap getDrillMap ()

Returns the drill map assigned to the template.

Returns
  • the corresponding drill map for the template

public abstract int getOrdinal ()

Returns
  • the ordinal polsition (starts from 1).

public abstract String getRawValue ()

Returns the raw data value of this row value.

Returns
  • String The raw data value, which is the unformatted value of this row value. Return null when there is no raw value specified for this row value. Note that the report needs to have the EnumDSSXMLResultFlags#DssXmlResultNoNumberFormating flag set before the results are obtained in order this method to return the actual raw value.

public abstract WebHeader getRowHeader ()

Returns the corresponding row-axis WebHeader at the finest granularity associated with the this WebRowValue. This only makes sense for metric row values. Null is returned for subtotals, or if no associated header is found.

Returns
  • the corresponding row-axis WebHeader

public abstract WebHeader getRowHeader (int enumWebHeaderType)

Returns the corresponding row-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.

Returns
  • the corresponding row-axis WebHeader of specified type.

public abstract int getSemantics ()

The meaning of this form value. This implies, but is not the same as, the data type. Values of this attribute are derived from the COM interface EnumDSSBaseFormType:

 1 = date/time
 2 = number
 3 = text
 4 = image
 5 = anchor (a URL to go to if the user clicks the cell)
 6 = email
 7 = HTML tag
 8 = date
 9 = time
 

Returns
  • the semantic type.

public abstract WebTitle getSubtotalTitle ()

This method will return the WebTitle corresponding to the 'Subtotal' WebHeader, if this is subtotal value, otherwise null will be returned. If both the row and column axis define a subtotal header, the row title will be returned.

Returns
  • WebTitle of 'Subtotal' WebHeader.

public abstract int getTransactionAction ()

return thresholdAction EnumDSSXMLTransactionAction

Returns
  • thresholdAction EnumDSSXMLTransactionAction

public abstract int getType ()

Returns

public abstract String getValue ()

Returns
  • the row value.

public abstract boolean isEditDisable ()

Returns the unit can be edit or not.

Returns
  • the unit can be edit or not.

public abstract boolean isFirst ()

Returns
  • if this row value is the first element in the encapsulating WebRow collection.

public abstract boolean isLast ()

Returns
  • if this row value is the last element in the encapsulating WebRow collection.

public abstract void setTransactionAction (int action)

set thresholdAction EnumDSSXMLTransactionAction

Parameters
action EnumDSSXMLTransactionAction