Source for file Item.php

Documentation is available at Item.php

  1. <?php
  2. /**
  3. * Item includes the question, set of responses, answer, and any supporting
  4. * instructions and media. These elements are all contained in a Data object
  5. * whose content is not specified in the OSID. Items are characterized by
  6. * their response type, for example multiple-choice. ItemType is meaningful
  7. * to an application and not specifcally defined in the OSID. The unique Id
  8. * for an item is set by the AssessmentManager's createItem method's
  9. * implementation.
  10. *
  11. * <p>
  12. * OSID Version: 2.0
  13. * </p>
  14. *
  15. * <p>
  16. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  17. * O.K.I&#46; OSID Definition License}.
  18. * </p>
  19. *
  20. * @package org.osid.assessment
  21. */
  22. class Item
  23. {
  24. /**
  25. * Update the display name for this Item.
  26. *
  27. * @param string $displayName
  28. *
  29. * @throws object AssessmentException An exception with one of
  30. * the following messages defined in
  31. * org.osid.assessment.AssessmentException may be thrown: {@link }
  32. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  33. * OPERATION_FAILED}, {@link }
  34. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  35. * PERMISSION_DENIED}, {@link }
  36. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  37. * CONFIGURATION_ERROR}, {@link }
  38. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  39. * UNIMPLEMENTED}, {@link }
  40. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  41. * NULL_ARGUMENT}
  42. *
  43. * @access public
  44. */
  45. function updateDisplayName ( $displayName ) {
  46. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  47. }
  48.  
  49. /**
  50. * Update the description for this Item.
  51. *
  52. * @param string $description
  53. *
  54. * @throws object AssessmentException An exception with one of
  55. * the following messages defined in
  56. * org.osid.assessment.AssessmentException may be thrown: {@link }
  57. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  58. * OPERATION_FAILED}, {@link }
  59. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  60. * PERMISSION_DENIED}, {@link }
  61. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  62. * CONFIGURATION_ERROR}, {@link }
  63. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  64. * UNIMPLEMENTED}, {@link }
  65. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  66. * NULL_ARGUMENT}
  67. *
  68. * @access public
  69. */
  70. function updateDescription ( $description ) {
  71. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  72. }
  73.  
  74. /**
  75. * Update the data for this Item. This may include the question, responses,
  76. * answer, instructions, media, etc. The structure of the Data is not
  77. * defined in the OSID.
  78. *
  79. * @param object mixed $data (original type: java.io.Serializable)
  80. *
  81. * @throws object AssessmentException An exception with one of
  82. * the following messages defined in
  83. * org.osid.assessment.AssessmentException may be thrown: {@link }
  84. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  85. * OPERATION_FAILED}, {@link }
  86. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  87. * PERMISSION_DENIED}, {@link }
  88. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  89. * CONFIGURATION_ERROR}, {@link }
  90. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  91. * UNIMPLEMENTED}, {@link }
  92. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  93. * NULL_ARGUMENT}
  94. *
  95. * @access public
  96. */
  97. function updateData ( $data ) {
  98. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  99. }
  100.  
  101. /**
  102. * Get the display name for this Item.
  103. *
  104. * @return string
  105. *
  106. * @throws object AssessmentException An exception with one of
  107. * the following messages defined in
  108. * org.osid.assessment.AssessmentException may be thrown: {@link }
  109. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  110. * OPERATION_FAILED}, {@link }
  111. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  112. * PERMISSION_DENIED}, {@link }
  113. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  114. * CONFIGURATION_ERROR}, {@link }
  115. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  116. * UNIMPLEMENTED}
  117. *
  118. * @access public
  119. */
  120. function getDisplayName () {
  121. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  122. }
  123.  
  124. /**
  125. * Get the description for this Item.
  126. *
  127. * @return string
  128. *
  129. * @throws object AssessmentException An exception with one of
  130. * the following messages defined in
  131. * org.osid.assessment.AssessmentException may be thrown: {@link }
  132. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  133. * OPERATION_FAILED}, {@link }
  134. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  135. * PERMISSION_DENIED}, {@link }
  136. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  137. * CONFIGURATION_ERROR}, {@link }
  138. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  139. * UNIMPLEMENTED}
  140. *
  141. * @access public
  142. */
  143. function getDescription () {
  144. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  145. }
  146.  
  147. /**
  148. * Get the unique Id for this Item.
  149. *
  150. * @return object Id
  151. *
  152. * @throws object AssessmentException An exception with one of
  153. * the following messages defined in
  154. * org.osid.assessment.AssessmentException may be thrown: {@link }
  155. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  156. * OPERATION_FAILED}, {@link }
  157. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  158. * PERMISSION_DENIED}, {@link }
  159. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  160. * CONFIGURATION_ERROR}, {@link }
  161. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  162. * UNIMPLEMENTED}
  163. *
  164. * @access public
  165. */
  166. function getId () {
  167. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  168. }
  169.  
  170. /**
  171. * Get the ItemType for this Item.
  172. *
  173. * @return object Type
  174. *
  175. * @throws object AssessmentException An exception with one of
  176. * the following messages defined in
  177. * org.osid.assessment.AssessmentException may be thrown: {@link }
  178. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  179. * OPERATION_FAILED}, {@link }
  180. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  181. * PERMISSION_DENIED}, {@link }
  182. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  183. * CONFIGURATION_ERROR}, {@link }
  184. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  185. * UNIMPLEMENTED}
  186. *
  187. * @access public
  188. */
  189. function getItemType () {
  190. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  191. }
  192.  
  193. /**
  194. * Get all the Property Types for Item.
  195. *
  196. * @return object TypeIterator
  197. *
  198. * @throws object AssessmentException An exception with one of
  199. * the following messages defined in
  200. * org.osid.assessment.AssessmentException may be thrown: {@link }
  201. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  202. * OPERATION_FAILED}, {@link }
  203. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  204. * PERMISSION_DENIED}, {@link }
  205. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  206. * CONFIGURATION_ERROR}, {@link }
  207. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  208. * UNIMPLEMENTED}
  209. *
  210. * @access public
  211. */
  212. function getPropertyTypes () {
  213. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  214. }
  215.  
  216. /**
  217. * Get the Properties associated with this Item.
  218. *
  219. * @return object PropertiesIterator
  220. *
  221. * @throws object AssessmentException An exception with one of
  222. * the following messages defined in
  223. * org.osid.assessment.AssessmentException may be thrown: {@link }
  224. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  225. * OPERATION_FAILED}, {@link }
  226. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  227. * PERMISSION_DENIED}, {@link }
  228. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  229. * CONFIGURATION_ERROR}, {@link }
  230. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  231. * UNIMPLEMENTED}
  232. *
  233. * @access public
  234. */
  235. function getProperties () {
  236. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  237. }
  238.  
  239. /**
  240. * Get the Data for this Item. This may include the question, responses,
  241. * answer, instructions, media, etc. The structure of the Data is not
  242. * defined in the OSID.
  243. *
  244. * @return object mixed (original type: java.io.Serializable)
  245. *
  246. * @throws object AssessmentException An exception with one of
  247. * the following messages defined in
  248. * org.osid.assessment.AssessmentException may be thrown: {@link }
  249. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  250. * OPERATION_FAILED}, {@link }
  251. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  252. * PERMISSION_DENIED}, {@link }
  253. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  254. * CONFIGURATION_ERROR}, {@link }
  255. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  256. * UNIMPLEMENTED}
  257. *
  258. * @access public
  259. */
  260. function getData () {
  261. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  262. }
  263.  
  264. /**
  265. * Get the Properties of this Type associated with this Item.
  266. *
  267. * @param object Type $propertiesType
  268. *
  269. * @return object Properties
  270. *
  271. * @throws object AssessmentException An exception with one of
  272. * the following messages defined in
  273. * org.osid.assessment.AssessmentException may be thrown: {@link }
  274. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  275. * OPERATION_FAILED}, {@link }
  276. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  277. * PERMISSION_DENIED}, {@link }
  278. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  279. * CONFIGURATION_ERROR}, {@link }
  280. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  281. * UNIMPLEMENTED}, {@link }
  282. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  283. * NULL_ARGUMENT}, {@link }
  284. * org.osid.assessment.AssessmentException#UNKNOWN_TYPE
  285. * UNKNOWN_TYPE}
  286. *
  287. * @access public
  288. */
  289. function getPropertiesByType ( $propertiesType ) {
  290. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  291. }
  292. }
  293.  
  294. ?>

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