org.osid.dictionary

Interface Entry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Entry
extends OsidObject

An Entry contains a key and a value. The key and value have a Type such that an entry is identified by the combination of the key, key type, and value type. The Type may indicate the key and value are simple strings or, more complex objects may be managed that allows for a translation from one arbitrary object to another.

Method Summary

Methods

Modifier and Type	Method and Description
EntryRecord	getEntryRecord(Type entryRecordType) Gets the entry record corresponding to the given Entry record Type.
java.lang.Object	getKey() Gets the key of this entry.
Type	getKeyType() Gets the Type of this entry key.
java.lang.Object	getValue() Gets the value in this entry.
Type	getValueType() Gets the Type of this entry value.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getKeyType

Type getKeyType()

Gets the Type of this entry key.

Returns:

the key Type

Compliance:

mandatory - This method must be implemented.

getKey

java.lang.Object getKey()

Gets the key of this entry.

Returns:

the key

Compliance:

mandatory - This method must be implemented.

getValueType

Type getValueType()

Gets the Type of this entry value.

Returns:

the value Type

Compliance:

mandatory - This method must be implemented.

getValue

java.lang.Object getValue()

Gets the value in this entry.

Returns:

the value

Compliance:

mandatory - This method must be implemented.

getEntryRecord

EntryRecord getEntryRecord(Type entryRecordType)
                           throws OperationFailedException

Gets the entry record corresponding to the given Entry record Type. This method is used to retrieve an object implementing the requested record. The entryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(entryRecordType) is true .

Parameters:

entryRecordType - the type of the record to retrieve

Returns:

the entry record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.