Package com.sas.metadata.remote

Interface ForeignKey

All Superinterfaces:
CMetadata, Key, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface ForeignKey extends Key
Represents the fact that a table contains a foreign key to another table.

Attributes of ForeignKey are:

Associations of ForeignKey are:

Usage

To create an instance of this ForeignKey, use the factory create methods.
Example: create a ForeignKey with name "ForeignKey_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();
 ForeignKey myObject = (ForeignKey) factory.createComplexMetadataObject(objectStore, "ForeignKey_Object", MetadataObjects.FOREIGNKEY, "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_KEYASSOCIATIONS_NAME

      static final String ASSOCIATION_KEYASSOCIATIONS_NAME
      Constant used for the name of the KeyAssociations association.

      KeyAssociations: The list of association objects that associate a column in this foreign key to a column in the unique key.  

      See Also:

    • ASSOCIATION_PARTNERUNIQUEKEY_NAME

      static final String ASSOCIATION_PARTNERUNIQUEKEY_NAME
      Constant used for the name of the PartnerUniqueKey association.

      PartnerUniqueKey: The unique key associated with this foreign 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 contains this foreign 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:
      KeyAssociations
      PartnerUniqueKey
      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.

    • getKeyAssociations

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

    • getPartnerUniqueKeys

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

    • getPartnerUniqueKey

      UniqueKey getPartnerUniqueKey() throws RemoteException, MdException
      Gets the UniqueKey for PartnerUniqueKey
      Returns:
      The UniqueKey ( null if not set) of PartnerUniqueKeywhich can be of type:
      UniqueKey
      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.

    • getKeyAssociations

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

    • getPartnerUniqueKeys

      AssociationList getPartnerUniqueKeys(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of PartnerUniqueKeys
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of PartnerUniqueKeys which can be of type:
      UniqueKey
      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.

    • setKeyAssociations

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

    • setKeyAssociations

      void setKeyAssociations(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.

    • setPartnerUniqueKeys

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

    • setPartnerUniqueKeys

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

    • setPartnerUniqueKey

      void setPartnerUniqueKey(UniqueKey inObject) throws RemoteException
      Sets the PartnerUniqueKeys list 0th element to be inObject.
      Parameters:
      inObject - UniqueKey
      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.