Docs For Class Dictionary

Class Dictionary

Description

Dictionary provides support for adding, removing, and getting entries by

Dictionary name and domain and then by tag. A tag is a String that is used to identify an entry. This could be welcome_message, xyzDialog, etc. The entry is a serializable object stored and retrieved with the Dictionary, for example the text of the welcome_message or the dialog resource for xyzDialog. The domain identifies the context for the Dictionary. This could be java.util.Locale that is a designation that varies by country, language, or other context.

<p> OSID Version: 2.0 </p>

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

Located in /harmoni/oki2/osid/dictionary/Dictionary.php (line 24)

Method Summary

void addEntry (string $tag, object mixed $value)

string getDescription ()

string getDisplayName ()

object mixed getDomain ()

object mixed getEntry (mixed $tag, string $tag )

object Id getId ()

object StringIterator getTags ()

void removeEntry (mixed $tag, string $tag )

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

Methods

addEntry (line 196)

Add an entry, a string-tag / serializable-value pair, to this Dictionary. If the tag is already used, the new value overwrites the old or this can be an error.

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, ALREADY_ADDED

void addEntry (string $tag, object mixed $value)

string $tag
object mixed $value: (original type: java.io.Serializable)

getDescription (line 118)

Get the description for this Dictionary.

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

string getDescription ()

getDisplayName (line 95)

Get the display name for this Dictionary.

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

string getDisplayName ()

getDomain (line 166)

Get the domain of this Dictionary. The domain identifies the context for the Dictionary. This could be java.util.Locale that is a designation that varies by country, language, or other context.

return: (original type: java.io.Serializable)
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 mixed getDomain ()

getEntry (line 253)

Get the entry in this Dictionary that corresponds to the specified tag.

return: (original type: java.io.Serializable)
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, UNKNOWN_TAG

object mixed getEntry (mixed $tag, string $tag )

string $tag

getId (line 141)

Get the unique Id for this Dictionary.

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 Id getId ()

getTags (line 277)

Get all the tags in this Dictionary. 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 StringIterator getTags ()

removeEntry (line 224)

Remove the specified entry, a string-tag / serializable-value pair, from this Dictionary.

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, UNKNOWN_TAG

void removeEntry (mixed $tag, string $tag )

string $tag

updateDescription (line 72)

Update the description for this Dictionary.

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

void updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 47)

Update the display name for this Dictionary.

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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

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