public interface

PageByElementList

com.microstrategy.web.app.beans.PageByElementList

Class Overview

The PageByElementList is the interface used by the PageByBean to represent the list of elements available for 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.

The PageByElementList returns the enumeration of all possible elements for its corresponding PageByUnit. Each element implements the PageByElement interface. This class also provides a convenience method that returns the PageByElement currently selected (if any).

Summary

Public Methods
abstract String getAlias()
Convenience method to return the alias for the element list.
abstract PageByElement getCurrentElement()
Convenience method that returns the PageByElement instace marked as current (selected).
abstract Enumeration getElements()
Returns an enumeration of the available PageByElements for the current unit.

Public Methods

public abstract String getAlias ()

Convenience method to return the alias for the element list.

Returns
  • the name of the list

public abstract PageByElement getCurrentElement ()

Convenience method that returns the PageByElement instace marked as current (selected).

Returns
  • The first PageByElement in the list marked as current.

public abstract Enumeration getElements ()

Returns an enumeration of the available PageByElements for the current unit.

Returns
  • The corresponding enumeration of PageByElements