Package com.sas.metadata.remote

Interface Key

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
ForeignKey, UniqueKey
public interface Key extends SecondaryType
Represents keys on tables.

Attributes of Key are:

Associations of Key are:

Usage

To create an instance of this Key, use the factory create methods.
Example: create a Key with name "Key_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();
 Key myObject = (Key) factory.createComplexMetadataObject(objectStore, "Key_Object", MetadataObjects.KEY, "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_DISPLAYCOLUMNS_NAME

      static final String ASSOCIATION_DISPLAYCOLUMNS_NAME
      Constant used for the name of the DisplayColumns association.

      DisplayColumns: The columns that contain the displayable text for a key.  

      See Also:

    • ASSOCIATION_KEYEDCOLUMNS_NAME

      static final String ASSOCIATION_KEYEDCOLUMNS_NAME
      Constant used for the name of the KeyedColumns association.

      KeyedColumns: The columns that comprise this key. This association may be with a single column, or with multiple columns, if the key is a composite key. 

      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 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:
      DisplayColumns
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getDisplayColumns

      AssociationList getDisplayColumns() throws RemoteException, MdException
      Gets the AssociationList of DisplayColumns
      Returns:
      Returns the AssociationList of DisplayColumns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getKeyedColumns

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

    • getDisplayColumns

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

    • getKeyedColumns

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

    • setDisplayColumns

      void setDisplayColumns(AssociationList list) throws RemoteException
      Sets the DisplayColumns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setDisplayColumns

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

    • setKeyedColumns

      void setKeyedColumns(AssociationList list) throws RemoteException
      Sets the KeyedColumns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setKeyedColumns

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