Package com.sas.metadata.remote

Interface Prototype

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Prototype extends PrimaryType
Used to create a template for creating other metadata objects or set of metadata objects that represent a concept. Any metadata type may be associated with a prototype. The prototype includes all possible valid options or properties that may be used to describe the metadata object that is represented by the prototype. The prototype may then be used to drive a UI that will aid an end user in the creation of metadata. The model allows for any metadata type to be considered a prototype, however, there is currently no defined way to specify that the given metadata object is a prototype that does not represent a particular entity. It is recommended that only metadata types that have a role attribute be considered candidates for defining new prototypes. The role attribute is typically used by clients to filter the metadata before displaying to end users.

Attributes of Prototype are:

Associations of Prototype are:

Usage

To create an instance of this Prototype, use the factory create methods.
Example: create a Prototype with name "Prototype_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();
 Prototype myObject = (Prototype) factory.createComplexMetadataObject(objectStore, "Prototype_Object", MetadataObjects.PROTOTYPE, "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 metadata type that is described by this prototype. For example, a TCPIPConnection, SoftwareComponent, SASLibrary.

      See Also:

    • ASSOCIATION_ASSOCIATIONS_NAME

      static final String ASSOCIATION_ASSOCIATIONS_NAME
      Constant used for the name of the Associations association.

      Associations: The association property objects that are reference this object as the partner in an association.  

      See Also:

    • ASSOCIATION_PROTOTYPEPROPERTIES_NAME

      static final String ASSOCIATION_PROTOTYPEPROPERTIES_NAME
      Constant used for the name of the PrototypeProperties association.

      PrototypeProperties: The attribute and association properties of this prototype.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      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:
      Associations
      PrototypeProperties
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      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.

    • getAssociations

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

    • getPrototypeProperties

      AssociationList getPrototypeProperties() throws RemoteException, MdException
      Gets the AssociationList of PrototypeProperties
      Returns:
      Returns the AssociationList of PrototypeProperties which can be of type:
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociations

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

    • getPrototypeProperties

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

    • setAssociations

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

    • setAssociations

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

    • setPrototypeProperties

      void setPrototypeProperties(AssociationList list) throws RemoteException
      Sets the PrototypeProperties list to be list. Objects of which can be of type:
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setPrototypeProperties

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