Package com.sas.metadata.remote

Interface HierarchyLevel

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface HierarchyLevel extends PrimaryType
Represents a level within one and only one hierarchy. A level may participate in multiple heirarchies as represented by the levels association to HierarchyLevel objects. A HierachyLevel object is not deleted when a level is deleted, OLAP will instead collapse the hierarchy if the associated level object is not found.

Attributes of HierarchyLevel are:

Associations of HierarchyLevel are:

Usage

To create an instance of this HierarchyLevel, use the factory create methods.
Example: create a HierarchyLevel with name "HierarchyLevel_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 HierarchyLevel myObject = (HierarchyLevel) factory.createComplexMetadataObject(objectStore, "HierarchyLevel_Object", MetadataObjects.HIERARCHYLEVEL, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_UNIQUENAME_NAME

      static final String ATTRIBUTE_UNIQUENAME_NAME
      Constant used for the name of the UniqueName attribute.

      UniqueName: UniqueName

      See Also:

    • ASSOCIATION_ASSOCIATEDHIERARCHY_NAME

      static final String ASSOCIATION_ASSOCIATEDHIERARCHY_NAME
      Constant used for the name of the AssociatedHierarchy association.

      AssociatedHierarchy: The hierarchy, if any, that has this hierarchy level at the root.  

      See Also:

    • ASSOCIATION_ASSOCIATEDLEVEL_NAME

      static final String ASSOCIATION_ASSOCIATEDLEVEL_NAME
      Constant used for the name of the AssociatedLevel association.

      AssociatedLevel: The level that owns this hierarchy level.  

      See Also:

    • ASSOCIATION_PARENTLEVEL_NAME

      static final String ASSOCIATION_PARENTLEVEL_NAME
      Constant used for the name of the ParentLevel association.

      ParentLevel: The parent level.  

      See Also:

    • ASSOCIATION_SUBLEVEL_NAME

      static final String ASSOCIATION_SUBLEVEL_NAME
      Constant used for the name of the SubLevel association.

      SubLevel: The sublevel. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      AssociatedHierarchy
      AssociatedLevel
      ParentLevel
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueName

      String getUniqueName() throws RemoteException
      Gets the String value of UniqueName
      Returns:
      The UniqueName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueNameState

      int getUniqueNameState() throws RemoteException
      Gets the Metadata State of UniqueName
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueNameMaxLength

      int getUniqueNameMaxLength() throws RemoteException
      Gets the maximum length of UniqueName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAssociatedHierarchys

      AssociationList getAssociatedHierarchys() throws RemoteException, MdException
      Gets the AssociationList of AssociatedHierarchys
      Returns:
      Returns the AssociationList of AssociatedHierarchys which can be of type:
      Hierarchy
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getAssociatedHierarchy

      Hierarchy getAssociatedHierarchy() throws RemoteException, MdException
      Gets the Hierarchy for AssociatedHierarchy
      Returns:
      The Hierarchy ( null if not set) of AssociatedHierarchywhich can be of type:
      Hierarchy
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedLevels

      AssociationList getAssociatedLevels() throws RemoteException, MdException
      Gets the AssociationList of AssociatedLevels
      Returns:
      Returns the AssociationList of AssociatedLevels which can be of type:
      Level
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getAssociatedLevel

      Level getAssociatedLevel() throws RemoteException, MdException
      Gets the Level for AssociatedLevel
      Returns:
      The Level ( null if not set) of AssociatedLevelwhich can be of type:
      Level
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getParentLevels

      AssociationList getParentLevels() throws RemoteException, MdException
      Gets the AssociationList of ParentLevels
      Returns:
      Returns the AssociationList of ParentLevels which can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getParentLevel

      HierarchyLevel getParentLevel() throws RemoteException, MdException
      Gets the HierarchyLevel for ParentLevel
      Returns:
      The HierarchyLevel ( null if not set) of ParentLevelwhich can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubLevels

      AssociationList getSubLevels() throws RemoteException, MdException
      Gets the Association list of SubLevels
      Returns:
      The AssociationList of SubLevels which can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubLevel

      HierarchyLevel getSubLevel() throws RemoteException, MdException
      Gets the HierarchyLevel for SubLevel
      Returns:
      The HierarchyLevel ( null if not set ) of SubLevel which can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedHierarchys

      AssociationList getAssociatedHierarchys(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedHierarchys
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of AssociatedHierarchys which can be of type:
      Hierarchy
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedLevels

      AssociationList getAssociatedLevels(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedLevels
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of AssociatedLevels which can be of type:
      Level
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getParentLevels

      AssociationList getParentLevels(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of ParentLevels
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of ParentLevels which can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubLevels

      AssociationList getSubLevels(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of SubLevels
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the SubLevels which can be of type:
      HierarchyLevel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setUniqueName

      void setUniqueName(String inUniqueName) throws RemoteException
      Sets the UniqueName value and sets the state to MetadataState.LOCAL.
      Parameters:
      inUniqueName - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setUniqueName

      void setUniqueName(String inUniqueName, int state) throws RemoteException
      Sets the UniqueName Metadata State.
      Parameters:
      inUniqueName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setUniqueNameState

      void setUniqueNameState(int state) throws RemoteException
      Sets the Metadata State of UniqueName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedHierarchys

      void setAssociatedHierarchys(AssociationList list) throws RemoteException
      Sets the AssociatedHierarchys list to be list. Object of which can be of type:
      Hierarchy
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedHierarchys

      void setAssociatedHierarchys(AssociationList list, int state) throws RemoteException
      Sets the AssociatedHierarchys list to be list. Object of which can be of type:
      Hierarchy
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedHierarchy

      void setAssociatedHierarchy(Hierarchy inObject) throws RemoteException
      Sets the AssociatedHierarchys list 0th element to be inObject.
      Parameters:
      inObject - Hierarchy
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedLevels

      void setAssociatedLevels(AssociationList list) throws RemoteException
      Sets the AssociatedLevels list to be list. Object of which can be of type:
      Level
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedLevels

      void setAssociatedLevels(AssociationList list, int state) throws RemoteException
      Sets the AssociatedLevels list to be list. Object of which can be of type:
      Level
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedLevel

      void setAssociatedLevel(Level inObject) throws RemoteException
      Sets the AssociatedLevels list 0th element to be inObject.
      Parameters:
      inObject - Level
      Throws:
      RemoteException - If error communicating with remote object.

    • setParentLevels

      void setParentLevels(AssociationList list) throws RemoteException
      Sets the ParentLevels list to be list. Object of which can be of type:
      HierarchyLevel
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setParentLevels

      void setParentLevels(AssociationList list, int state) throws RemoteException
      Sets the ParentLevels list to be list. Object of which can be of type:
      HierarchyLevel
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setParentLevel

      void setParentLevel(HierarchyLevel inObject) throws RemoteException
      Sets the ParentLevels list 0th element to be inObject.
      Parameters:
      inObject - HierarchyLevel
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubLevels

      void setSubLevels(AssociationList list) throws RemoteException
      Sets the SubLevels list to be list. Objects of which can be of type:
      HierarchyLevel
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubLevels

      void setSubLevels(AssociationList list, int state) throws RemoteException
      Sets the SubLevels list to be list. Objects of which can be of type:
      HierarchyLevel
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubLevel

      void setSubLevel(HierarchyLevel inObject) throws RemoteException
      Sets the SubLevels list 0th element to be inObject.
      Parameters:
      inObject - HierarchyLevel
      Throws:
      RemoteException - If error communicating with remote object.