org.eclipse.higgins.idas.api
Interface IMetadataValue

All Known Subinterfaces:
IComplexMetaValue, ISimpleMetaValue

public interface IMetadataValue

Holds the value of a metadata element.

This interface is not intended to be instantiated (only used as a super-interface). When the value is a Literal (isSimple() returns true), an instance of this interface may be cast to ISimpleMetaValue, and the table found at ITypedValue.getData() is used to determine the type returned from ITypedValue.getData(). When the value is a Resource (isSimple() returns false), an instance of this interface may be cast to IComplexMetaValue.


Method Summary
 boolean equals(IMetadataValue value)
          returns true if this IMetadataValue is equal to the passed IMetadataValue This should test the metadata ID and the value for equality.
 IMetadataValueModel getModel()
          Returns the model for this type of metadata value as it is defined in the context's schema.
 boolean isSimple()
           
 void remove()
          Removes this value from its IMetadata container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called.
 

Method Detail

isSimple

public boolean isSimple()
                 throws IdASException
Throws:
IdASException

remove

public void remove()
            throws IdASException
Removes this value from its IMetadata container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called.

Throws:
{@link - IdASException}
IdASException

equals

public boolean equals(IMetadataValue value)
               throws IdASException
returns true if this IMetadataValue is equal to the passed IMetadataValue This should test the metadata ID and the value for equality.

Throws:
IdASException

getModel

public IMetadataValueModel getModel()
                             throws IdASException
Returns the model for this type of metadata value as it is defined in the context's schema.

Returns:
the model for this metadata value
Throws:
IdASException