OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.Entry
Implementsosid.OsidObject
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.Typethe key Type
CompliancemandatoryThis method must be implemented.
MethodgetKey
Description

Gets the key of this entry.

Returnobjectthe key
CompliancemandatoryThis method must be implemented.
MethodgetValueType
Description

Gets the Type of this entry value.

Returnosid.type.Typethe value Type
CompliancemandatoryThis method must be implemented.
MethodgetValue
Description

Gets the value in this entry.

Returnobjectthe value
CompliancemandatoryThis 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.TypeentryRecordTypethe type of the record to retrieve
Returnosid.dictionary.records.EntryRecordthe entry record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.