Interface Dictionary

All Superinterfaces:
Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable
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.

Like all OsidObjects, Dictionary is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getDictionaryRecord

      DictionaryRecord getDictionaryRecord(Type dictionaryRecordType) throws OperationFailedException
      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.
      Parameters:
      dictionaryRecordType - the type of the record to retrieve
      Returns:
      the dictionary record
      Throws:
      NullArgumentException - dictionaryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(dictionaryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.