OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.Dictionary
Implementsosid.OsidCatalog
Description

A Dictionary represents a collection of entries. Like all OSID objects, a Dictionary is identified by its Id and any persisted references should use the Id.

MethodgetDictionaryRecord
Description

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

Parametersosid.type.TypedictionaryRecordTypethe type of the record to retrieve
Returnosid.dictionary.records.DictionaryRecordthe dictionary record
ErrorsNULL_ARGUMENT dictionaryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dictionaryRecordType) is false
CompliancemandatoryThis method must be implemented.