Source for file GradeRecord.php

Documentation is available at GradeRecord.php

  1. <?php 
    2. 

  2.  
    3. 

  3. /**
    4. 

  4.  * GradeRecord includes a reference to a gradable object, an Agent Id, a Grade,
    5. 

  5.  * and GradeType.
    6. 

  6.  * 
    7. 

  7.  * <p>
    8. 

  8.  * OSID Version: 2.0
    9. 

  9.  * </p>
    10. 

  10.  * 
    11. 

  11.  * <p>
    12. 

  12.  * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
    13. 

  13.  * O.K.I&#46; OSID Definition License}.
    14. 

  14.  * </p>
    15. 

  15.  * 
    16. 

  16.  * @package org.osid.grading
    17. 

  17.  */
    18. 

  18. class GradeRecord
    19. 

  19. {
    20. 

  20.     /**
    21. 

  21.      * Update the value for this Grade.
    22. 

  22.      * 
    23. 

  23.      * @param object mixed $gradeValue (original type: java.io.Serializable)
    24. 

  24.      * 
    25. 

  25.      * @throws object GradingException An exception with one of the
    26. 

  26.      *          following messages defined in org.osid.grading.GradingException
    27. 

  27.      *          may be thrown:  {@link }
    28. 

  28.      *          org.osid.grading.GradingException#OPERATION_FAILED
    29. 

  29.      *          OPERATION_FAILED}, {@link }
    30. 

  30.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    31. 

  31.      *          PERMISSION_DENIED}, {@link }
    32. 

  32.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    33. 

  33.      *          CONFIGURATION_ERROR}, {@link }
    34. 

  34.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    35. 

  35.      * 
    36. 

  36.      * @access public
    37. 

  37.      */
    38. 

  38.     function updateGradeValue ( $gradeValue ) { 
    39. 

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

  40.     } 
    41. 

  41.  
    42. 

  42.     /**
    43. 

  43.      * Get the unique Id for this GradeRecord's GradableObject.
    44. 

  44.      *  
    45. 

  45.      * @return object Id 
    46. 

  46.      * 
    47. 

  47.      * @throws object GradingException An exception with one of the
    48. 

  48.      *          following messages defined in org.osid.grading.GradingException
    49. 

  49.      *          may be thrown:  {@link }
    50. 

  50.      *          org.osid.grading.GradingException#OPERATION_FAILED
    51. 

  51.      *          OPERATION_FAILED}, {@link }
    52. 

  52.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    53. 

  53.      *          PERMISSION_DENIED}, {@link }
    54. 

  54.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    55. 

  55.      *          CONFIGURATION_ERROR}, {@link }
    56. 

  56.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    57. 

  57.      * 
    58. 

  58.      * @access public
    59. 

  59.      */
    60. 

  60.     function getGradableObject () { 
    61. 

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

  62.     } 
    63. 

  63.  
    64. 

  64.     /**
    65. 

  65.      * Get the Agent Id associated with this GradeRecord.  The Agent in this
    66. 

  66.      * context is not the person who took the test nor, necessarily, the
    67. 

  67.      * person who is grading.  It is the person whose "GradeBook" this is, for
    68. 

  68.      * example the CourseSection instructor.
    69. 

  69.      *  
    70. 

  70.      * @return object Id 
    71. 

  71.      * 
    72. 

  72.      * @throws object GradingException An exception with one of the
    73. 

  73.      *          following messages defined in org.osid.grading.GradingException
    74. 

  74.      *          may be thrown:  {@link }
    75. 

  75.      *          org.osid.grading.GradingException#OPERATION_FAILED
    76. 

  76.      *          OPERATION_FAILED}, {@link }
    77. 

  77.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    78. 

  78.      *          PERMISSION_DENIED}, {@link }
    79. 

  79.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    80. 

  80.      *          CONFIGURATION_ERROR}, {@link }
    81. 

  81.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    82. 

  82.      * 
    83. 

  83.      * @access public
    84. 

  84.      */
    85. 

  85.     function getAgentId () { 
    86. 

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

  87.     } 
    88. 

  88.  
    89. 

  89.     /**
    90. 

  90.      * Get the value for this Grade.
    91. 

  91.      *  
    92. 

  92.      * @return object mixed (original type: java.io.Serializable)
    93. 

  93.      * 
    94. 

  94.      * @throws object GradingException An exception with one of the
    95. 

  95.      *          following messages defined in org.osid.grading.GradingException
    96. 

  96.      *          may be thrown:  {@link }
    97. 

  97.      *          org.osid.grading.GradingException#OPERATION_FAILED
    98. 

  98.      *          OPERATION_FAILED}, {@link }
    99. 

  99.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    100. 

  100.      *          PERMISSION_DENIED}, {@link }
    101. 

  101.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    102. 

  102.      *          CONFIGURATION_ERROR}, {@link }
    103. 

  103.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    104. 

  104.      * 
    105. 

  105.      * @access public
    106. 

  106.      */
    107. 

  107.     function getGradeValue () { 
    108. 

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

  109.     } 
    110. 

  110.  
    111. 

  111.     /**
    112. 

  112.      * Get the Id of the Agent who modified this GradeRecord.
    113. 

  113.      *  
    114. 

  114.      * @return object Id 
    115. 

  115.      * 
    116. 

  116.      * @throws object GradingException An exception with one of the
    117. 

  117.      *          following messages defined in org.osid.grading.GradingException
    118. 

  118.      *          may be thrown:  {@link }
    119. 

  119.      *          org.osid.grading.GradingException#OPERATION_FAILED
    120. 

  120.      *          OPERATION_FAILED}, {@link }
    121. 

  121.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    122. 

  122.      *          PERMISSION_DENIED}, {@link }
    123. 

  123.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    124. 

  124.      *          CONFIGURATION_ERROR}, {@link }
    125. 

  125.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    126. 

  126.      * 
    127. 

  127.      * @access public
    128. 

  128.      */
    129. 

  129.     function getModifiedBy () { 
    130. 

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

  131.     } 
    132. 

  132.  
    133. 

  133.     /**
    134. 

  134.      * Get the date when this GradeRecord was modified.
    135. 

  135.      *  
    136. 

  136.      * @return int 
    137. 

  137.      * 
    138. 

  138.      * @throws object GradingException An exception with one of the
    139. 

  139.      *          following messages defined in org.osid.grading.GradingException
    140. 

  140.      *          may be thrown:  {@link }
    141. 

  141.      *          org.osid.grading.GradingException#OPERATION_FAILED
    142. 

  142.      *          OPERATION_FAILED}, {@link }
    143. 

  143.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    144. 

  144.      *          PERMISSION_DENIED}, {@link }
    145. 

  145.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    146. 

  146.      *          CONFIGURATION_ERROR}, {@link }
    147. 

  147.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    148. 

  148.      * 
    149. 

  149.      * @access public
    150. 

  150.      */
    151. 

  151.     function getModifiedDate () { 
    152. 

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

  153.     } 
    154. 

  154.  
    155. 

  155.     /**
    156. 

  156.      * Get the GradeRecordType for this GradeRecord.  This is the Type of the
    157. 

  157.      * GradeRecord, which is distinct from the Type of Grade.  A GradeRecord
    158. 

  158.      * Type might be advisory, mid-term, final, etc, while a Grade Type might
    159. 

  159.      * be letter, numeric, etc.
    160. 

  160.      *  
    161. 

  161.      * @return object Type 
    162. 

  162.      * 
    163. 

  163.      * @throws object GradingException An exception with one of the
    164. 

  164.      *          following messages defined in org.osid.grading.GradingException
    165. 

  165.      *          may be thrown:  {@link }
    166. 

  166.      *          org.osid.grading.GradingException#OPERATION_FAILED
    167. 

  167.      *          OPERATION_FAILED}, {@link }
    168. 

  168.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    169. 

  169.      *          PERMISSION_DENIED}, {@link }
    170. 

  170.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    171. 

  171.      *          CONFIGURATION_ERROR}, {@link }
    172. 

  172.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    173. 

  173.      * 
    174. 

  174.      * @access public
    175. 

  175.      */
    176. 

  176.     function getGradeRecordType () { 
    177. 

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

  178.     } 
    179. 

  179.  
    180. 

  180.     /**
    181. 

  181.      * Get the GradeType associated with the GradableObject and Grade.
    182. 

  182.      *  
    183. 

  183.      * @return object Type 
    184. 

  184.      * 
    185. 

  185.      * @throws object GradingException An exception with one of the
    186. 

  186.      *          following messages defined in org.osid.grading.GradingException
    187. 

  187.      *          may be thrown:  {@link }
    188. 

  188.      *          org.osid.grading.GradingException#OPERATION_FAILED
    189. 

  189.      *          OPERATION_FAILED}, {@link }
    190. 

  190.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    191. 

  191.      *          PERMISSION_DENIED}, {@link }
    192. 

  192.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    193. 

  193.      *          CONFIGURATION_ERROR}, {@link }
    194. 

  194.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    195. 

  195.      * 
    196. 

  196.      * @access public
    197. 

  197.      */
    198. 

  198.     function getGradeType () { 
    199. 

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

  200.     } 
    201. 

  201.  
    202. 

  202.     /**
    203. 

  203.      * Get all the Property Types for  GradeRecord.
    204. 

  204.      *  
    205. 

  205.      * @return object TypeIterator 
    206. 

  206.      * 
    207. 

  207.      * @throws object GradingException An exception with one of the
    208. 

  208.      *          following messages defined in org.osid.grading.GradingException
    209. 

  209.      *          may be thrown:  {@link }
    210. 

  210.      *          org.osid.grading.GradingException#OPERATION_FAILED
    211. 

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

  212.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    213. 

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

  214.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    215. 

  215.      *          CONFIGURATION_ERROR}, {@link }
    216. 

  216.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    217. 

  217.      * 
    218. 

  218.      * @access public
    219. 

  219.      */
    220. 

  220.     function getPropertyTypes () { 
    221. 

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

  222.     } 
    223. 

  223.  
    224. 

  224.     /**
    225. 

  225.      * Get the Properties of this Type associated with this GradeRecord.
    226. 

  226.      * 
    227. 

  227.      * @param object Type $propertiesType 
    228. 

  228.      *  
    229. 

  229.      * @return object Properties 
    230. 

  230.      * 
    231. 

  231.      * @throws object GradingException An exception with one of the
    232. 

  232.      *          following messages defined in org.osid.grading.GradingException
    233. 

  233.      *          may be thrown:  {@link }
    234. 

  234.      *          org.osid.grading.GradingException#OPERATION_FAILED
    235. 

  235.      *          OPERATION_FAILED}, {@link }
    236. 

  236.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    237. 

  237.      *          PERMISSION_DENIED}, {@link }
    238. 

  238.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    239. 

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

  240.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED},
    241. 

  241.      *          {@link org.osid.grading.GradingException#NULL_ARGUMENT}
    242. 

  242.      *          NULL_ARGUMENT}, {@link }
    243. 

  243.      *          org.osid.grading.GradingException#UNKNOWN_TYPE UNKNOWN_TYPE}
    244. 

  244.      * 
    245. 

  245.      * @access public
    246. 

  246.      */
    247. 

  247.     function getPropertiesByType ( $propertiesType ) { 
    248. 

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

  249.     } 
    250. 

  250.  
    251. 

  251.     /**
    252. 

  252.      * Get the Properties associated with this GradeRecord.
    253. 

  253.      *  
    254. 

  254.      * @return object PropertiesIterator 
    255. 

  255.      * 
    256. 

  256.      * @throws object GradingException An exception with one of the
    257. 

  257.      *          following messages defined in org.osid.grading.GradingException
    258. 

  258.      *          may be thrown:  {@link }
    259. 

  259.      *          org.osid.grading.GradingException#OPERATION_FAILED
    260. 

  260.      *          OPERATION_FAILED}, {@link }
    261. 

  261.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    262. 

  262.      *          PERMISSION_DENIED}, {@link }
    263. 

  263.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    264. 

  264.      *          CONFIGURATION_ERROR}, {@link }
    265. 

  265.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    266. 

  266.      * 
    267. 

  267.      * @access public
    268. 

  268.      */
    269. 

  269.     function getProperties () { 
    270. 

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

  271.     } 
    272. 

  272. }
    273. 

  273.  
    274. 

  274. ?>
    275.

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