Package com.sas.metadata.remote

Interface UniqueKey

All Superinterfaces:
CMetadata, Key, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface UniqueKey extends Key
A representation of the unique and primary keys of a table. It is also associated with the columns in the table that comprise the key.

Attributes of UniqueKey are:

Associations of UniqueKey are:

Usage

To create an instance of this UniqueKey, use the factory create methods.
Example: create a UniqueKey with name "UniqueKey_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();
 UniqueKey myObject = (UniqueKey) factory.createComplexMetadataObject(objectStore, "UniqueKey_Object", MetadataObjects.UNIQUEKEY, "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_ISPRIMARY_NAME

      static final String ATTRIBUTE_ISPRIMARY_NAME
      Constant used for the name of the IsPrimary attribute.

      IsPrimary: If the key is a primary key, the value of this attribute should be true. The default value is false.

      See Also:

    • ASSOCIATION_FOREIGNKEYS_NAME

      static final String ASSOCIATION_FOREIGNKEYS_NAME
      Constant used for the name of the ForeignKeys association.

      ForeignKeys: The list of foreign keys that are associated with this unique key. 

      See Also:

    • ASSOCIATION_TABLE_NAME

      static final String ASSOCIATION_TABLE_NAME
      Constant used for the name of the Table association.

      Table: The table that owns this unique key. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getIsPrimary

      int getIsPrimary() throws RemoteException
      Gets the int value of IsPrimary
      Returns:
      The IsPrimary
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsPrimaryState

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

    • getForeignKeys

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

    • getTables

      AssociationList getTables() throws RemoteException, MdException
      Gets the Association list of Tables
      Returns:
      The AssociationList of Tables which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTable

      DataTable getTable() throws RemoteException, MdException
      Gets the DataTable for Table
      Returns:
      The DataTable ( null if not set ) of Table which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getForeignKeys

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

    • getTables

      AssociationList getTables(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Tables
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Tables which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setIsPrimary

      void setIsPrimary(int inIsPrimary) throws RemoteException
      Sets the IsPrimary value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsPrimary - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsPrimary

      void setIsPrimary(int inIsPrimary, int state) throws RemoteException
      Sets the IsPrimary Metadata State.
      Parameters:
      inIsPrimary - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsPrimary

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

    • setIsPrimary

      void setIsPrimary(String inIsPrimary, int state) throws RemoteException
      Sets the IsPrimary value and Metadata State.
      Parameters:
      inIsPrimary - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsPrimaryState

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

    • setForeignKeys

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

    • setForeignKeys

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

    • setTables

      void setTables(AssociationList list) throws RemoteException
      Sets the Tables list to be list. Objects of which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setTables

      void setTables(AssociationList list, int state) throws RemoteException
      Sets the Tables list to be list. Objects of which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setTable

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