Package com.sas.metadata.remote

Interface PrototypeProperty

All Superinterfaces:
AbstractProperty, CMetadata, LocalizedType, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
AssociationProperty, AttributeProperty
public interface PrototypeProperty extends AbstractProperty
This is the super type for types that define properties that are for prototype objects only. These are either AttributeProperty or AssociationProperty objects.

Attributes of PrototypeProperty are:

Associations of PrototypeProperty are:

Usage

To create an instance of this PrototypeProperty, use the factory create methods.
Example: create a PrototypeProperty with name "PrototypeProperty_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();
 PrototypeProperty myObject = (PrototypeProperty) factory.createComplexMetadataObject(objectStore, "PrototypeProperty_Object", MetadataObjects.PROTOTYPEPROPERTY, "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_OWNINGPROTOTYPE_NAME

      static final String ASSOCIATION_OWNINGPROTOTYPE_NAME
      Constant used for the name of the OwningPrototype association.

      OwningPrototype: The prototype that owns these properties. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getOwningPrototypes

      AssociationList getOwningPrototypes() throws RemoteException, MdException
      Gets the Association list of OwningPrototypes
      Returns:
      The AssociationList of OwningPrototypes 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.

    • getOwningPrototype

      Prototype getOwningPrototype() throws RemoteException, MdException
      Gets the Prototype for OwningPrototype
      Returns:
      The Prototype ( null if not set ) of OwningPrototype 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.

    • getOwningPrototypes

      AssociationList getOwningPrototypes(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OwningPrototypes
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the OwningPrototypes 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.

    • setOwningPrototypes

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

    • setOwningPrototypes

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

    • setOwningPrototype

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