Source for file Dictionary.php

Documentation is available at Dictionary.php

  1. <?php 
    2. 

  2.  
    3. 

  3. /**
    4. 

  4.  * Dictionary provides support for adding, removing, and getting entries by
    5. 

  5.  * Dictionary name and domain and then by tag.  A tag is a String that is used
    6. 

  6.  * to identify an entry.  This could be welcome_message, xyzDialog, etc.  The
    7. 

  7.  * entry is a serializable object stored and retrieved with the Dictionary,
    8. 

  8.  * for example the text of the welcome_message or the dialog resource for
    9. 

  9.  * xyzDialog.  The domain identifies the context for the Dictionary. This
    10. 

  10.  * could be java.util.Locale that is a designation that varies by country,
    11. 

  11.  * language, or other context.
    12. 

  12.  * 
    13. 

  13.  * <p>
    14. 

  14.  * OSID Version: 2.0
    15. 

  15.  * </p>
    16. 

  16.  * 
    17. 

  17.  * <p>
    18. 

  18.  * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
    19. 

  19.  * O.K.I&#46; OSID Definition License}.
    20. 

  20.  * </p>
    21. 

  21.  * 
    22. 

  22.  * @package org.osid.dictionary
    23. 

  23.  */
    24. 

  24. class Dictionary
    25. 

  25. {
    26. 

  26.     /**
    27. 

  27.      * Update the display name for this Dictionary.
    28. 

  28.      * 
    29. 

  29.      * @param string $displayName 
    30. 

  30.      * 
    31. 

  31.      * @throws object DictionaryException An exception with one of
    32. 

  32.      *          the following messages defined in
    33. 

  33.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    34. 

  34.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    35. 

  35.      *          OPERATION_FAILED}, {@link }
    36. 

  36.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    37. 

  37.      *          CONFIGURATION_ERROR}, {@link }
    38. 

  38.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    39. 

  39.      *          PERMISSION_DENIED}, {@link }
    40. 

  40.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    41. 

  41.      *          UNIMPLEMENTED}, {@link }
    42. 

  42.      *          org.osid.dictionary.DictionaryException#NULL_ARGUMENT
    43. 

  43.      *          NULL_ARGUMENT}
    44. 

  44.      * 
    45. 

  45.      * @access public
    46. 

  46.      */
    47. 

  47.     function updateDisplayName ( $displayName ) { 
    48. 

  48.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    49. 

  49.     } 
    50. 

  50.  
    51. 

  51.     /**
    52. 

  52.      * Update the description for this Dictionary.
    53. 

  53.      * 
    54. 

  54.      * @param string $description 
    55. 

  55.      * 
    56. 

  56.      * @throws object DictionaryException An exception with one of
    57. 

  57.      *          the following messages defined in
    58. 

  58.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    59. 

  59.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    60. 

  60.      *          OPERATION_FAILED}, {@link }
    61. 

  61.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    62. 

  62.      *          CONFIGURATION_ERROR}, {@link }
    63. 

  63.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    64. 

  64.      *          PERMISSION_DENIED}, {@link }
    65. 

  65.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    66. 

  66.      *          UNIMPLEMENTED}, {@link }
    67. 

  67.      *          org.osid.dictionary.DictionaryException#NULL_ARGUMENT
    68. 

  68.      *          NULL_ARGUMENT}
    69. 

  69.      * 
    70. 

  70.      * @access public
    71. 

  71.      */
    72. 

  72.     function updateDescription ( $description ) { 
    73. 

  73.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    74. 

  74.     } 
    75. 

  75.  
    76. 

  76.     /**
    77. 

  77.      * Get the display name for this Dictionary.
    78. 

  78.      *  
    79. 

  79.      * @return string 
    80. 

  80.      * 
    81. 

  81.      * @throws object DictionaryException An exception with one of
    82. 

  82.      *          the following messages defined in
    83. 

  83.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    84. 

  84.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    85. 

  85.      *          OPERATION_FAILED}, {@link }
    86. 

  86.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    87. 

  87.      *          CONFIGURATION_ERROR}, {@link }
    88. 

  88.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    89. 

  89.      *          PERMISSION_DENIED}, {@link }
    90. 

  90.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    91. 

  91.      *          UNIMPLEMENTED}
    92. 

  92.      * 
    93. 

  93.      * @access public
    94. 

  94.      */
    95. 

  95.     function getDisplayName () { 
    96. 

  96.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    97. 

  97.     } 
    98. 

  98.  
    99. 

  99.     /**
    100. 

  100.      * Get the description for this Dictionary.
    101. 

  101.      *  
    102. 

  102.      * @return string 
    103. 

  103.      * 
    104. 

  104.      * @throws object DictionaryException An exception with one of
    105. 

  105.      *          the following messages defined in
    106. 

  106.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    107. 

  107.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    108. 

  108.      *          OPERATION_FAILED}, {@link }
    109. 

  109.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    110. 

  110.      *          CONFIGURATION_ERROR}, {@link }
    111. 

  111.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    112. 

  112.      *          PERMISSION_DENIED}, {@link }
    113. 

  113.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    114. 

  114.      *          UNIMPLEMENTED}
    115. 

  115.      * 
    116. 

  116.      * @access public
    117. 

  117.      */
    118. 

  118.     function getDescription () { 
    119. 

  119.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    120. 

  120.     } 
    121. 

  121.  
    122. 

  122.     /**
    123. 

  123.      * Get the unique Id for this Dictionary.
    124. 

  124.      *  
    125. 

  125.      * @return object Id 
    126. 

  126.      * 
    127. 

  127.      * @throws object DictionaryException An exception with one of
    128. 

  128.      *          the following messages defined in
    129. 

  129.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    130. 

  130.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    131. 

  131.      *          OPERATION_FAILED}, {@link }
    132. 

  132.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    133. 

  133.      *          CONFIGURATION_ERROR}, {@link }
    134. 

  134.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    135. 

  135.      *          PERMISSION_DENIED}, {@link }
    136. 

  136.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    137. 

  137.      *          UNIMPLEMENTED}
    138. 

  138.      * 
    139. 

  139.      * @access public
    140. 

  140.      */
    141. 

  141.     function getId () { 
    142. 

  142.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    143. 

  143.     } 
    144. 

  144.  
    145. 

  145.     /**
    146. 

  146.      * Get the domain of this Dictionary.  The domain identifies the context
    147. 

  147.      * for the Dictionary. This could be java.util.Locale that is a
    148. 

  148.      * designation that varies by country, language, or other context.
    149. 

  149.      *  
    150. 

  150.      * @return object mixed (original type: java.io.Serializable)
    151. 

  151.      * 
    152. 

  152.      * @throws object DictionaryException An exception with one of
    153. 

  153.      *          the following messages defined in
    154. 

  154.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    155. 

  155.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    156. 

  156.      *          OPERATION_FAILED}, {@link }
    157. 

  157.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    158. 

  158.      *          CONFIGURATION_ERROR}, {@link }
    159. 

  159.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    160. 

  160.      *          PERMISSION_DENIED}, {@link }
    161. 

  161.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    162. 

  162.      *          UNIMPLEMENTED}
    163. 

  163.      * 
    164. 

  164.      * @access public
    165. 

  165.      */
    166. 

  166.     function getDomain () { 
    167. 

  167.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    168. 

  168.     } 
    169. 

  169.  
    170. 

  170.     /**
    171. 

  171.      * Add an entry, a string-tag / serializable-value pair, to this
    172. 

  172.      * Dictionary.  If the tag is already used, the new value overwrites the
    173. 

  173.      * old or this can be an error.
    174. 

  174.      * 
    175. 

  175.      * @param string $tag 
    176. 

  176.      * @param object mixed $value (original type: java.io.Serializable)
    177. 

  177.      * 
    178. 

  178.      * @throws object DictionaryException An exception with one of
    179. 

  179.      *          the following messages defined in
    180. 

  180.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    181. 

  181.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    182. 

  182.      *          OPERATION_FAILED}, {@link }
    183. 

  183.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    184. 

  184.      *          CONFIGURATION_ERROR}, {@link }
    185. 

  185.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    186. 

  186.      *          PERMISSION_DENIED}, {@link }
    187. 

  187.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    188. 

  188.      *          UNIMPLEMENTED}, {@link }
    189. 

  189.      *          org.osid.dictionary.DictionaryException#NULL_ARGUMENT
    190. 

  190.      *          NULL_ARGUMENT}, {@link }
    191. 

  191.      *          org.osid.dictionary.DictionaryException#ALREADY_ADDED
    192. 

  192.      *          ALREADY_ADDED}
    193. 

  193.      * 
    194. 

  194.      * @access public
    195. 

  195.      */
    196. 

  196.     function addEntry ( $tag, $value ) { 
    197. 

  197.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    198. 

  198.     } 
    199. 

  199.  
    200. 

  200.     /**
    201. 

  201.      * Remove the specified entry, a string-tag / serializable-value pair, from
    202. 

  202.      * this Dictionary.
    203. 

  203.      * 
    204. 

  204.      * @param string $tag 
    205. 

  205.      * 
    206. 

  206.      * @throws object DictionaryException An exception with one of
    207. 

  207.      *          the following messages defined in
    208. 

  208.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    209. 

  209.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    210. 

  210.      *          OPERATION_FAILED}, {@link }
    211. 

  211.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    212. 

  212.      *          CONFIGURATION_ERROR}, {@link }
    213. 

  213.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    214. 

  214.      *          PERMISSION_DENIED}, {@link }
    215. 

  215.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    216. 

  216.      *          UNIMPLEMENTED}, {@link }
    217. 

  217.      *          org.osid.dictionary.DictionaryException#NULL_ARGUMENT
    218. 

  218.      *          NULL_ARGUMENT}, {@link }
    219. 

  219.      *          org.osid.dictionary.DictionaryException#UNKNOWN_TAG
    220. 

  220.      *          UNKNOWN_TAG}
    221. 

  221.      * 
    222. 

  222.      * @access public
    223. 

  223.      */
    224. 

  224.     function removeEntry ( $tag ) { 
    225. 

  225.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    226. 

  226.     } 
    227. 

  227.  
    228. 

  228.     /**
    229. 

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

  230.      * 
    231. 

  231.      * @param string $tag 
    232. 

  232.      *  
    233. 

  233.      * @return object mixed (original type: java.io.Serializable)
    234. 

  234.      * 
    235. 

  235.      * @throws object DictionaryException An exception with one of
    236. 

  236.      *          the following messages defined in
    237. 

  237.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    238. 

  238.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    239. 

  239.      *          OPERATION_FAILED}, {@link }
    240. 

  240.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    241. 

  241.      *          CONFIGURATION_ERROR}, {@link }
    242. 

  242.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    243. 

  243.      *          PERMISSION_DENIED}, {@link }
    244. 

  244.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    245. 

  245.      *          UNIMPLEMENTED},  {@link }
    246. 

  246.      *          org.osid.dictionary.DictionaryException#NULL_ARGUMENT
    247. 

  247.      *          NULL_ARGUMENT}, {@link }
    248. 

  248.      *          org.osid.dictionary.DictionaryException#UNKNOWN_TAG
    249. 

  249.      *          UNKNOWN_TAG}
    250. 

  250.      * 
    251. 

  251.      * @access public
    252. 

  252.      */
    253. 

  253.     function getEntry ( $tag ) { 
    254. 

  254.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    255. 

  255.     } 
    256. 

  256.  
    257. 

  257.     /**
    258. 

  258.      * Get all the tags in this Dictionary.  Iterators return a set, one at a
    259. 

  259.      * time.
    260. 

  260.      *  
    261. 

  261.      * @return object StringIterator 
    262. 

  262.      * 
    263. 

  263.      * @throws object DictionaryException An exception with one of
    264. 

  264.      *          the following messages defined in
    265. 

  265.      *          org.osid.dictionary.DiictionaryException may be thrown:  {@link }
    266. 

  266.      *          org.osid.dictionary.DictionaryException#OPERATION_FAILED
    267. 

  267.      *          OPERATION_FAILED}, {@link }
    268. 

  268.      *          org.osid.dictionary.DictionaryException#CONFIGURATION_ERROR
    269. 

  269.      *          CONFIGURATION_ERROR}, {@link }
    270. 

  270.      *          org.osid.dictionary.DictionaryException#PERMISSION_DENIED
    271. 

  271.      *          PERMISSION_DENIED}, {@link }
    272. 

  272.      *          org.osid.dictionary.DictionaryException#UNIMPLEMENTED
    273. 

  273.      *          UNIMPLEMENTED}
    274. 

  274.      * 
    275. 

  275.      * @access public
    276. 

  276.      */
    277. 

  277.     function getTags () { 
    278. 

  278.         die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    279. 

  279.     } 
    280. 

  280. }
    281. 

  281.  
    282. 

  282. ?>
    283.

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