Package com.microstrategy.web.app.beans

Interface PageByElement

  • public interface PageByElement
    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.

    Since:
    MicroStrategy Web 8.0.0
    See Also:
    PageByBean, PageByUnit, PageByElementList

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Returns the element's display name.
      java.lang.String getID()
      Returns the unique identifier of the element.
      int getSemantics()
      The meaning of the form where the display value is taken from.
      boolean isAllElement()
      Returns true if the element represents the (All) element
      boolean isCurrent()
      Identifies whether it is the current (selected) element.

    • Method Detail

      • getID

        java.lang.String getID()
        Returns the unique identifier of the element.
        Returns:
        The element ID.

      • getDisplayName

        java.lang.String getDisplayName()
        Returns the element's display name.
        Returns:
        The element name.

      • isCurrent

        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.

      • getSemantics

        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.

      • isAllElement

        boolean isAllElement()
        Returns true if the element represents the (All) element
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.1.0