Source for file Evaluation.php

Documentation is available at Evaluation.php

  1. <?php
  2. /**
  3. * Evaluation has a specific Type. There is also supporting data which
  4. * contains the evaluation that is meaningful to the application and is not
  5. * specified by the OSID.
  6. *
  7. * <p>
  8. * OSID Version: 2.0
  9. * </p>
  10. *
  11. * <p>
  12. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  13. * O.K.I&#46; OSID Definition License}.
  14. * </p>
  15. *
  16. * @package org.osid.assessment
  17. */
  18. class Evaluation
  19. {
  20. /**
  21. * Update the display name for this Evaluation.
  22. *
  23. * @param string $displayName
  24. *
  25. * @throws object AssessmentException An exception with one of
  26. * the following messages defined in
  27. * org.osid.assessment.AssessmentException may be thrown: {@link }
  28. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  29. * OPERATION_FAILED}, {@link }
  30. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  31. * PERMISSION_DENIED}, {@link }
  32. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  33. * CONFIGURATION_ERROR}, {@link }
  34. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  35. * UNIMPLEMENTED}, {@link }
  36. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  37. * NULL_ARGUMENT}
  38. *
  39. * @access public
  40. */
  41. function updateDisplayName ( $displayName ) {
  42. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  43. }
  44.  
  45. /**
  46. * Update the data for this Evaluation. The structure of the Data is not
  47. * defined in the OSID.
  48. *
  49. * @param object mixed $data (original type: java.io.Serializable)
  50. *
  51. * @throws object AssessmentException An exception with one of
  52. * the following messages defined in
  53. * org.osid.assessment.AssessmentException may be thrown: {@link }
  54. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  55. * OPERATION_FAILED}, {@link }
  56. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  57. * PERMISSION_DENIED}, {@link }
  58. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  59. * CONFIGURATION_ERROR}, {@link }
  60. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  61. * UNIMPLEMENTED}, {@link }
  62. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  63. * NULL_ARGUMENT}
  64. *
  65. * @access public
  66. */
  67. function updateData ( $data ) {
  68. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  69. }
  70.  
  71. /**
  72. * Get the display name for this Evaluation.
  73. *
  74. * @return string
  75. *
  76. * @throws object AssessmentException An exception with one of
  77. * the following messages defined in
  78. * org.osid.assessment.AssessmentException may be thrown: {@link }
  79. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  80. * OPERATION_FAILED}, {@link }
  81. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  82. * PERMISSION_DENIED}, {@link }
  83. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  84. * CONFIGURATION_ERROR}, {@link }
  85. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  86. * UNIMPLEMENTED}
  87. *
  88. * @access public
  89. */
  90. function getDisplayName () {
  91. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  92. }
  93.  
  94. /**
  95. * Get the unique Id for this Evaluation.
  96. *
  97. * @return object Id
  98. *
  99. * @throws object AssessmentException An exception with one of
  100. * the following messages defined in
  101. * org.osid.assessment.AssessmentException may be thrown: {@link }
  102. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  103. * OPERATION_FAILED}, {@link }
  104. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  105. * PERMISSION_DENIED}, {@link }
  106. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  107. * CONFIGURATION_ERROR}, {@link }
  108. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  109. * UNIMPLEMENTED}
  110. *
  111. * @access public
  112. */
  113. function getId () {
  114. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  115. }
  116.  
  117. /**
  118. * Get the EvaluationType for this Evaluation. EvaluationType The
  119. * structure of the Data is not defined in the OSID.
  120. *
  121. * @return object Type
  122. *
  123. * @throws object AssessmentException An exception with one of
  124. * the following messages defined in
  125. * org.osid.assessment.AssessmentException may be thrown: {@link }
  126. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  127. * OPERATION_FAILED}, {@link }
  128. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  129. * PERMISSION_DENIED}, {@link }
  130. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  131. * CONFIGURATION_ERROR}, {@link }
  132. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  133. * UNIMPLEMENTED}
  134. *
  135. * @access public
  136. */
  137. function getType () {
  138. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  139. }
  140.  
  141. /**
  142. * Get the Id for the object taken.
  143. *
  144. * @return object Id
  145. *
  146. * @throws object AssessmentException An exception with one of
  147. * the following messages defined in
  148. * org.osid.assessment.AssessmentException may be thrown: {@link }
  149. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  150. * OPERATION_FAILED}, {@link }
  151. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  152. * PERMISSION_DENIED}, {@link }
  153. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  154. * CONFIGURATION_ERROR}, {@link }
  155. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  156. * UNIMPLEMENTED}
  157. *
  158. * @access public
  159. */
  160. function getObjectTaken () {
  161. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  162. }
  163.  
  164. /**
  165. * Get the Data for this Evaluation. The structure of the Data is not
  166. * defined in the OSID.
  167. *
  168. * @return object mixed (original type: java.io.Serializable)
  169. *
  170. * @throws object AssessmentException An exception with one of
  171. * the following messages defined in
  172. * org.osid.assessment.AssessmentException may be thrown: {@link }
  173. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  174. * OPERATION_FAILED}, {@link }
  175. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  176. * PERMISSION_DENIED}, {@link }
  177. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  178. * CONFIGURATION_ERROR}, {@link }
  179. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  180. * UNIMPLEMENTED}
  181. *
  182. * @access public
  183. */
  184. function getData () {
  185. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  186. }
  187.  
  188. /**
  189. * Get the agentId of the modifier of this Evaluation.
  190. *
  191. * @return object Id
  192. *
  193. * @throws object AssessmentException An exception with one of
  194. * the following messages defined in
  195. * org.osid.assessment.AssessmentException may be thrown: {@link }
  196. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  197. * OPERATION_FAILED}, {@link }
  198. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  199. * PERMISSION_DENIED}, {@link }
  200. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  201. * CONFIGURATION_ERROR}, {@link }
  202. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  203. * UNIMPLEMENTED}
  204. *
  205. * @access public
  206. */
  207. function getModifiedBy () {
  208. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  209. }
  210.  
  211. /**
  212. * Get the date when this Evaluation was modified.
  213. *
  214. * @return int
  215. *
  216. * @throws object AssessmentException An exception with one of
  217. * the following messages defined in
  218. * org.osid.assessment.AssessmentException may be thrown: {@link }
  219. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  220. * OPERATION_FAILED}, {@link }
  221. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  222. * PERMISSION_DENIED}, {@link }
  223. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  224. * CONFIGURATION_ERROR}, {@link }
  225. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  226. * UNIMPLEMENTED}
  227. *
  228. * @access public
  229. */
  230. function getModifiedDate () {
  231. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  232. }
  233. }
  234.  
  235. ?>

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