public interface

PageByElement

com.microstrategy.web.app.beans.PageByElement

Class Overview

The PageByElement is the interface used by the PageByBean to represent a single element of a PageByUnit.

A page-by unit controls the data displayed to the end-user: when a report or document is executed each unit is displayed with a combo-box that lists its elements; the data is automatically filtered based on the currently selected element. This interface represents each possible selection.

Summary

Public Methods
abstract String getDisplayName()
Returns the element's display name.
abstract String getID()
Returns the unique identifier of the element.
abstract int getSemantics()
The meaning of the form where the display value is taken from.
abstract boolean isAllElement()
Returns true if the element represents the (All) element
abstract boolean isCurrent()
Identifies whether it is the current (selected) element.

Public Methods

public abstract String getDisplayName ()

Returns the element's display name.

Returns
  • The element name.

public abstract String getID ()

Returns the unique identifier of the element.

Returns
  • The element ID.

public abstract int getSemantics ()

The meaning of the form where the display value is taken from. This implies, but is not the same as the data type. Values of this attribute are derived from the WebApi 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 boolean isAllElement ()

Returns true if the element represents the (All) element

Returns
  • boolean

public abstract boolean isCurrent ()

Identifies whether it is the current (selected) element. In a PageByElementList there should be at most one current element.

Returns
  • true if this is the currently selected element.