public interface Dictionary extends OsidCatalog
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.
Modifier and Type | Method and Description |
---|---|
DictionaryRecord |
getDictionaryRecord(Type dictionaryRecordType)
Gets the dictionary record corresponding to the given
Dictionary record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
DictionaryRecord getDictionaryRecord(Type dictionaryRecordType) throws OperationFailedException
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
.dictionaryRecordType
- the type of the record to retrieveNullArgumentException
- dictionaryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dictionaryRecordType)
is false
mandatory
- This method must be implemented.