Class DictionaryManager

Description

<p> DictionaryManager handles creating, deleting, and getting Dictionaries.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/dictionary/DictionaryManager.php (line 39)

OsidManager
   |
   --DictionaryManager
Method Summary
object Dictionary createDictionary (string $displayName, string $description, object mixed $domain)
void deleteDictionary (mixed $dictionaryId, object Id $dictionaryId )
object Dictionary getDictionary (mixed $dictionaryId, object Id $dictionaryId )
Methods
createDictionary (line 67)

Create a dictionary with the specified name and domain.

  • access: public
  • throws: object DictionaryException An exception with one of the following messages defined in org.osid.dictionary.DiictionaryException may be thrown: OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNIMPLEMENTED, NULL_ARGUMENT
object Dictionary createDictionary (string $displayName, string $description, object mixed $domain)
  • string $displayName
  • string $description
  • object mixed $domain: (original type: java.io.Serializable)
deleteDictionary (line 93)

Delete the dictionary with the specified unique Id.

  • access: public
  • throws: object DictionaryException An exception with one of the following messages defined in org.osid.dictionary.DiictionaryException may be thrown: OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNIMPLEMENTED, UNKNOWN_ID, NULL_ARGUMENT
void deleteDictionary (mixed $dictionaryId, object Id $dictionaryId )
getDictionaries (line 143)

Get all the Dictionaries. Iterators return a set, one at a time.

  • access: public
  • throws: object DictionaryException An exception with one of the following messages defined in org.osid.dictionary.DiictionaryException may be thrown: OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNIMPLEMENTED
object DictionaryIterator getDictionaries ()
getDictionary (line 120)

Get the dictionary with the specified unique Id.

  • access: public
  • throws: object DictionaryException An exception with one of the following messages defined in org.osid.dictionary.DiictionaryException may be thrown: OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNIMPLEMENTED, NULL_ARGUMENT
object Dictionary getDictionary (mixed $dictionaryId, object Id $dictionaryId )

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

Documentation generated on Wed, 19 Sep 2007 10:22:43 -0400 by phpDocumentor 1.3.0RC3