Package com.sas.metadata.remote

Interface NamedSet

All Superinterfaces:
CMetadata, Feature, GlobalFormula, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface NamedSet extends GlobalFormula
Beginning in SAS 9.3, represents a named set in dimension of a cube. A NamedSet object can be associated with one or many Hierarchy objects, in addition to the owning Cube.

Attributes of NamedSet are:

Associations of NamedSet are:

Usage

To create an instance of this NamedSet, use the factory create methods.
Example: create a NamedSet with name "NamedSet_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();
 NamedSet myObject = (NamedSet) factory.createComplexMetadataObject(objectStore, "NamedSet_Object", MetadataObjects.NAMEDSET, "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

    • ASSOCIATION_ASSOCIATEDHIERARCHIES_NAME

      static final String ASSOCIATION_ASSOCIATEDHIERARCHIES_NAME
      Constant used for the name of the AssociatedHierarchies association.

      AssociatedHierarchies: The hierarchies associated with this named set. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface Feature
      Specified by:
      initializeRequiredObjects in interface GlobalFormula
      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:
      Specified by:
      initializePredObjects in interface Feature
      Specified by:
      initializePredObjects in interface GlobalFormula
      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.

    • getAssociatedHierarchies

      AssociationList getAssociatedHierarchies() throws RemoteException, MdException
      Gets the Association list of AssociatedHierarchies
      Returns:
      The AssociationList of AssociatedHierarchies 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.

    • getAssociatedHierarchies

      AssociationList getAssociatedHierarchies(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedHierarchies
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociatedHierarchies 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.

    • setAssociatedHierarchies

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

    • setAssociatedHierarchies

      void setAssociatedHierarchies(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociatedHierarchies list to match the passed in AssociationList, sets the state of the AssociatedHierarchies
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.