Package com.sas.metadata.remote

Interface GroupByClause

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, QueryClause, Remote, Root, SecondaryType
public interface GroupByClause extends QueryClause
DEPRECATED: Has an association to the columns used to group this data.

Attributes of GroupByClause are:

Associations of GroupByClause are:

Usage

To create an instance of this GroupByClause, use the factory create methods.
Example: create a GroupByClause with name "GroupByClause_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();
 GroupByClause myObject = (GroupByClause) factory.createComplexMetadataObject(objectStore, "GroupByClause_Object", MetadataObjects.GROUPBYCLAUSE, "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_OWNINGSELECT_NAME

      static final String ASSOCIATION_OWNINGSELECT_NAME
      Constant used for the name of the OwningSelect association.

      OwningSelect: The select object that uses this groupby statement.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningSelect
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface QueryClause
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      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:
      OwningSelect
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface QueryClause
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getOwningSelects

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

    • getOwningSelect

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

    • getOwningSelects

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

    • setOwningSelects

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

    • setOwningSelects

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

    • setOwningSelect

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