Package com.sas.metadata.remote

Interface AssociationProperty

All Superinterfaces:
AbstractProperty, CMetadata, LocalizedType, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrototypeProperty, Remote, Root, SecondaryType
public interface AssociationProperty extends PrototypeProperty
The SAS Metadata Model provides a Prototype metadata type to define templates that can be used to create metadata entities. The AssociationProperty metadata type is used with other prototype objects to define the associations that are needed in a given scenario.

Attributes of AssociationProperty are:

Associations of AssociationProperty are:

Usage

To create an instance of this AssociationProperty, use the factory create methods.
Example: create a AssociationProperty with name "AssociationProperty_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();
 AssociationProperty myObject = (AssociationProperty) factory.createComplexMetadataObject(objectStore, "AssociationProperty_Object", MetadataObjects.ASSOCIATIONPROPERTY, "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_METADATATYPE_NAME

      static final String ATTRIBUTE_METADATATYPE_NAME
      Constant used for the name of the MetadataType attribute.

      MetadataType: The type that can be associated using this association name.

      See Also:

    • ATTRIBUTE_ASSOCIATIONNAME_NAME

      static final String ATTRIBUTE_ASSOCIATIONNAME_NAME
      Constant used for the name of the AssociationName attribute.

      AssociationName: The name of this association

      See Also:

    • ATTRIBUTE_PARTNERNAME_NAME

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

      PartnerName: The name the partner uses for this association

      See Also:

    • ATTRIBUTE_MINIMUM_NAME

      static final String ATTRIBUTE_MINIMUM_NAME
      Constant used for the name of the Minimum attribute.

      Minimum: The minimum number of associated objects.

      See Also:

    • ATTRIBUTE_MAXIMUM_NAME

      static final String ATTRIBUTE_MAXIMUM_NAME
      Constant used for the name of the Maximum attribute.

      Maximum: The maximum number of associated objects.

      See Also:

    • ASSOCIATION_ASSOCIATEDPROTOTYPES_NAME

      static final String ASSOCIATION_ASSOCIATEDPROTOTYPES_NAME
      Constant used for the name of the AssociatedPrototypes association.

      AssociatedPrototypes: The prototype objects used as partners with this association object. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getMetadataType

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

    • getMetadataTypeState

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

    • getMetadataTypeMaxLength

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

    • getAssociationName

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

    • getAssociationNameState

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

    • getAssociationNameMaxLength

      int getAssociationNameMaxLength() throws RemoteException
      Gets the maximum length of AssociationName
      Returns:
      The max size
      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.

    • getMinimum

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

    • getMinimumState

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

    • getMaximum

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

    • getMaximumState

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

    • getAssociatedPrototypes

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

    • getAssociatedPrototypes

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

    • setMetadataType

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

    • setMetadataType

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

    • setMetadataTypeState

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

    • setAssociationName

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

    • setAssociationName

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

    • setAssociationNameState

      void setAssociationNameState(int state) throws RemoteException
      Sets the Metadata State of AssociationName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote 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.

    • setMinimum

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

    • setMinimum

      void setMinimum(int inMinimum, int state) throws RemoteException
      Sets the Minimum Metadata State.
      Parameters:
      inMinimum - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinimum

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

    • setMinimum

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

    • setMinimumState

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

    • setMaximum

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

    • setMaximum

      void setMaximum(int inMaximum, int state) throws RemoteException
      Sets the Maximum Metadata State.
      Parameters:
      inMaximum - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMaximum

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

    • setMaximum

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

    • setMaximumState

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

    • setAssociatedPrototypes

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

    • setAssociatedPrototypes

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