Package com.sas.metadata.remote

Interface Extension

All Superinterfaces:
AbstractExtension, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface Extension extends AbstractExtension
Extension enables end users and application developers to define additional attributes that are not part of an object's metadata type definition. Use the Extension metadata type to define attributes that store character values.

Attributes of Extension are:

Associations of Extension are:

Usage

To create an instance of this Extension, use the factory create methods.
Example: create a Extension with name "Extension_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();
 Extension myObject = (Extension) factory.createComplexMetadataObject(objectStore, "Extension_Object", MetadataObjects.EXTENSION, "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_VALUE_NAME

      static final String ATTRIBUTE_VALUE_NAME
      Constant used for the name of the Value attribute.

      Value: This is the actual value of the extension in character format.

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getValue

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

    • getValueState

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

    • getValueMaxLength

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

    • setValue

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

    • setValue

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

    • setValueState

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