Package com.appliedolap.essbase

Interface EssMember

All Superinterfaces:
EssObject
All Known Implementing Classes:
EssMemberImpl
public interface EssMember extends EssObject

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

    EssObject.Type

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getChildCount()
    Returns the count of children of this member.
    List<EssMember>
    getChildren()
    Gets the children of this member.
    List<EssMember>
    getLeafDescendants()
    Gets the level-0 descendants of this member.
    int
    getLevel()
    Gets the level of the member as indicated by the REST API
    String
    getName()
    Returns the name of the member.
    EssMember
    getParent()
    Gets the parent member (not implemented yet).
    EssObject.Type
    getType()
    Gets the type of this object.
    boolean
    isDimension()
    Check if the member is a normal member or a dimension member.
    boolean
    isLeaf()
    Checks if the member is a leaf node or level 0 (has no children).

  • Method Details

    • getName

      String getName()
      Returns the name of the member.
      Specified by:
      getName in interface EssObject
      Returns:
      the member name

    • getType

      EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssObject
      Returns:
      the object type

    • getParent

      EssMember getParent()
      Gets the parent member (not implemented yet).
      Returns:
      the parent member, null if none (it's a dimension)

    • getLevel

      int getLevel()
      Gets the level of the member as indicated by the REST API
      Returns:
      the member level

    • isDimension

      boolean isDimension()
      Check if the member is a normal member or a dimension member.
      Returns:
      true if it's a dimension, false if normal member

    • isLeaf

      boolean isLeaf()
      Checks if the member is a leaf node or level 0 (has no children).
      Returns:
      true if level 0, false otherwise

    • getChildren

      List<EssMember> getChildren()
      Gets the children of this member.
      Returns:
      the children of this member or an empty collection if none.

    • getChildCount

      int getChildCount()
      Returns the count of children of this member.
      Returns:
      the number of children

    • getLeafDescendants

      List<EssMember> getLeafDescendants()
      Gets the level-0 descendants of this member. There is currently no REST API to do this in one call, so this method works recursively to fetch children of children and so on until the member has been explored.
      Returns:
      the level-0 descendants of this member, or a collection containing just this member if it has no children.