Package com.sas.metadata.remote

Interface CustomAssociation

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface CustomAssociation extends SecondaryType
Defines a custom association between any two metadata objects.

Attributes of CustomAssociation are:

Associations of CustomAssociation are:

Usage

To create an instance of this CustomAssociation, use the factory create methods.
Example: create a CustomAssociation with name "CustomAssociation_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();
 CustomAssociation myObject = (CustomAssociation) factory.createComplexMetadataObject(objectStore, "CustomAssociation_Object", MetadataObjects.CUSTOMASSOCIATION, "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_PARTNERNAME_NAME

      static final String ATTRIBUTE_PARTNERNAME_NAME
      Constant used for the name of the PartnerName attribute.

      PartnerName: The name of this custom association as referenced by the referenced object(s).

      See Also:

    • ATTRIBUTE_ISOWNED_NAME

      static final String ATTRIBUTE_ISOWNED_NAME
      Constant used for the name of the isOwned attribute.

      isOwned: An associated object should be deleted with the owning object if this value is true (!=0).

      See Also:

    • ASSOCIATION_ASSOCIATEDOBJECTS_NAME

      static final String ASSOCIATION_ASSOCIATEDOBJECTS_NAME
      Constant used for the name of the AssociatedObjects association.

      AssociatedObjects: The custom associations that reference this object. 

      See Also:

    • ASSOCIATION_OWNINGOBJECT_NAME

      static final String ASSOCIATION_OWNINGOBJECT_NAME
      Constant used for the name of the OwningObject association.

      OwningObject: The object that has this custom association. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getPartnerName

      String getPartnerName() throws RemoteException
      Gets the String value of PartnerName
      Returns:
      The PartnerName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPartnerNameState

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

    • getPartnerNameMaxLength

      int getPartnerNameMaxLength() throws RemoteException
      Gets the maximum length of PartnerName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getisOwned

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

    • getisOwnedState

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

    • getAssociatedObjects

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

    • getOwningObjects

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

    • getOwningObject

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

    • getAssociatedObjects

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

    • getOwningObjects

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

    • setPartnerName

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

    • setPartnerName

      void setPartnerName(String inPartnerName, int state) throws RemoteException
      Sets the PartnerName Metadata State.
      Parameters:
      inPartnerName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPartnerNameState

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

    • setisOwned

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

    • setisOwned

      void setisOwned(int inisOwned, int state) throws RemoteException
      Sets the isOwned Metadata State.
      Parameters:
      inisOwned - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setisOwned

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

    • setisOwned

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

    • setisOwnedState

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

    • setAssociatedObjects

      void setAssociatedObjects(AssociationList list) throws RemoteException
      Sets the AssociatedObjects list to be list. Objects of which can be of type:
      All types
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedObjects

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

    • setOwningObjects

      void setOwningObjects(AssociationList list) throws RemoteException
      Sets the OwningObjects list to be list. Objects of which can be of type:
      All types
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningObjects

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

    • setOwningObject

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