Package com.microstrategy.web.app.beans
Interface PageByElementList
-
public interface PageByElementList
ThePageByElementList
is the interface used by thePageByBean
to represent the list of elements available for aPageByUnit
.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 correspondingPageByUnit
. Each element implements thePageByElement
interface. This class also provides a convenience method that returns thePageByElement
currently selected (if any).- Since:
- MicroStrategy Web 8.0.0
- See Also:
PageByBean
,PageByUnit
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAlias()
Convenience method to return the alias for the element list.PageByElement
getCurrentElement()
Convenience method that returns thePageByElement
instace marked as current (selected).java.util.Enumeration
getElements()
Returns an enumeration of the availablePageByElements
for the current unit.
-
-
-
Method Detail
-
getElements
java.util.Enumeration getElements()
Returns an enumeration of the availablePageByElements
for the current unit.- Returns:
- The corresponding enumeration of
PageByElements
-
getCurrentElement
PageByElement getCurrentElement()
Convenience method that returns thePageByElement
instace marked as current (selected).- Returns:
- The first
PageByElement
in the list marked as current.
-
getAlias
java.lang.String getAlias()
Convenience method to return the alias for the element list.- Returns:
- the name of the list
- Since:
- MicroStrategy Web 8.1.2
-
-