OSID Logo
OSID Specifications
dictionary package
Version 3.1.0
Interfaceosid.dictionary.Entry
Implementsosid.OsidObject
Used Byosid.dictionary.EntryAdminSession
osid.dictionary.EntryList
osid.dictionary.EntryLookupSession
Description

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.

MethodgetKeyType
Description

Gets the Type of this entry key.

Returnosid.type.Type the key Type
Compliancemandatory This method must be implemented.
MethodgetKey
Description

Gets the key of this entry.

Returnobject the key
Compliancemandatory This method must be implemented.
MethodgetValueType
Description

Gets the Type of this entry value.

Returnosid.type.Type the value Type
Compliancemandatory This method must be implemented.
MethodgetValue
Description

Gets the value in this entry.

Returnobject the value
Compliancemandatory This method must be implemented.
MethodgetEntryRecord
Description

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.

Parametersosid.type.TypeentryRecordType the type of the record to retrieve
Returnosid.dictionary.records.EntryRecord the entry record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
Compliancemandatory This method must be implemented.