Package com.microstrategy.web.app.beans
Interface PageByElementList
- 
public interface PageByElementListThePageByElementListis the interface used by thePageByBeanto 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
PageByElementListreturns the enumeration of all possible elements for its correspondingPageByUnit. Each element implements thePageByElementinterface. This class also provides a convenience method that returns thePageByElementcurrently 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.StringgetAlias()Convenience method to return the alias for the element list.PageByElementgetCurrentElement()Convenience method that returns thePageByElementinstace marked as current (selected).java.util.EnumerationgetElements()Returns an enumeration of the availablePageByElementsfor the current unit. 
 - 
 
- 
- 
Method Detail
- 
getElements
java.util.Enumeration getElements()
Returns an enumeration of the availablePageByElementsfor the current unit.- Returns:
 - The corresponding enumeration of 
PageByElements 
 
- 
getCurrentElement
PageByElement getCurrentElement()
Convenience method that returns thePageByElementinstace marked as current (selected).- Returns:
 - The first 
PageByElementin 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
 
 
 - 
 
 -