Package com.sas.metadata.remote

Interface OnClause

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, QueryClause, Remote, Root, SecondaryType
public interface OnClause extends QueryClause
DEPRECATED: Represents an SQL ON clause.

Attributes of OnClause are:

Associations of OnClause are:

Usage

To create an instance of this OnClause, use the factory create methods.
Example: create a OnClause with name "OnClause_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();
 OnClause myObject = (OnClause) factory.createComplexMetadataObject(objectStore, "OnClause_Object", MetadataObjects.ONCLAUSE, "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_OWNINGJOIN_NAME

      static final String ASSOCIATION_OWNINGJOIN_NAME
      Constant used for the name of the OwningJoin association.

      OwningJoin: The join object that uses this on statement. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningJoin
      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:
      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.

    • getOwningJoins

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

    • getOwningJoin

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

    • getOwningJoins

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

    • setOwningJoins

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

    • setOwningJoins

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

    • setOwningJoin

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