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

Modifier and Type	Method	Description
EntryRecord	getEntryRecord(Type entryRecordType)	Gets the entry record corresponding to the given Entry record Type .This method is used to retrieve an object implementing the requested record.
Object	getKey()	Gets the key of this entry.
Type	getKeyType()	Gets the Type of this entry key.
Object	getValue()	Gets the value in this entry.
Type	getValueType()	Gets the Type of this entry value.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getKeyType

Type getKeyType()

Gets the Type of this entry key.

Returns:

the key Type

Compliance:

mandatory - This method must be implemented.

getKey

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

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.