Source for file GradableObject.php

Documentation is available at GradableObject.php

  1. <?php 
    2. 

  2.  
    3. 

  3. /**
    4. 

  4.  * GradableObject includes a Name, Description, Id, GradeType, CourseSection
    5. 

  5.  * reference, and External Reference to what is being graded.
    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 GradableObject
    19. 

  19. {
    20. 

  20.     /**
    21. 

  21.      * Update the display name for this Assignment.
    22. 

  22.      * 
    23. 

  23.      * @param string $displayName 
    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 updateDisplayName ( $displayName ) { 
    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.      * Update the description for this GradableObject.
    44. 

  44.      * 
    45. 

  45.      * @param string $description 
    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 updateDescription ( $description ) { 
    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 display name for this GradableObject.
    66. 

  66.      *  
    67. 

  67.      * @return string 
    68. 

  68.      * 
    69. 

  69.      * @throws object GradingException An exception with one of the
    70. 

  70.      *          following messages defined in org.osid.grading.GradingException
    71. 

  71.      *          may be thrown:  {@link }
    72. 

  72.      *          org.osid.grading.GradingException#OPERATION_FAILED
    73. 

  73.      *          OPERATION_FAILED}, {@link }
    74. 

  74.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    75. 

  75.      *          PERMISSION_DENIED}, {@link }
    76. 

  76.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    77. 

  77.      *          CONFIGURATION_ERROR}, {@link }
    78. 

  78.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    79. 

  79.      * 
    80. 

  80.      * @access public
    81. 

  81.      */
    82. 

  82.     function getDisplayName () { 
    83. 

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

  84.     } 
    85. 

  85.  
    86. 

  86.     /**
    87. 

  87.      * Get the description for this GradableObject.
    88. 

  88.      *  
    89. 

  89.      * @return string 
    90. 

  90.      * 
    91. 

  91.      * @throws object GradingException An exception with one of the
    92. 

  92.      *          following messages defined in org.osid.grading.GradingException
    93. 

  93.      *          may be thrown:  {@link }
    94. 

  94.      *          org.osid.grading.GradingException#OPERATION_FAILED
    95. 

  95.      *          OPERATION_FAILED}, {@link }
    96. 

  96.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    97. 

  97.      *          PERMISSION_DENIED}, {@link }
    98. 

  98.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    99. 

  99.      *          CONFIGURATION_ERROR}, {@link }
    100. 

  100.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    101. 

  101.      * 
    102. 

  102.      * @access public
    103. 

  103.      */
    104. 

  104.     function getDescription () { 
    105. 

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

  106.     } 
    107. 

  107.  
    108. 

  108.     /**
    109. 

  109.      * Get the unique Id for this GradableObject.
    110. 

  110.      *  
    111. 

  111.      * @return object Id 
    112. 

  112.      * 
    113. 

  113.      * @throws object GradingException An exception with one of the
    114. 

  114.      *          following messages defined in org.osid.grading.GradingException
    115. 

  115.      *          may be thrown:  {@link }
    116. 

  116.      *          org.osid.grading.GradingException#OPERATION_FAILED
    117. 

  117.      *          OPERATION_FAILED}, {@link }
    118. 

  118.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    119. 

  119.      *          PERMISSION_DENIED}, {@link }
    120. 

  120.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    121. 

  121.      *          CONFIGURATION_ERROR}, {@link }
    122. 

  122.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    123. 

  123.      * 
    124. 

  124.      * @access public
    125. 

  125.      */
    126. 

  126.     function getId () { 
    127. 

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

  128.     } 
    129. 

  129.  
    130. 

  130.     /**
    131. 

  131.      * Get the unique Id with a CourseSection. CourseSections are created and
    132. 

  132.      * managed through the CourseManagement OSID.
    133. 

  133.      *  
    134. 

  134.      * @return object Id 
    135. 

  135.      * 
    136. 

  136.      * @throws object GradingException An exception with one of the
    137. 

  137.      *          following messages defined in org.osid.grading.GradingException
    138. 

  138.      *          may be thrown:  {@link }
    139. 

  139.      *          org.osid.grading.GradingException#OPERATION_FAILED
    140. 

  140.      *          OPERATION_FAILED}, {@link }
    141. 

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

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

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

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

  145.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    146. 

  146.      * 
    147. 

  147.      * @access public
    148. 

  148.      */
    149. 

  149.     function getCourseSection () { 
    150. 

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

  151.     } 
    152. 

  152.  
    153. 

  153.     /**
    154. 

  154.      * Get the unique Id associated with some object that is being graded such
    155. 

  155.      * as an Assessment.
    156. 

  156.      *  
    157. 

  157.      * @return object Id 
    158. 

  158.      * 
    159. 

  159.      * @throws object GradingException An exception with one of the
    160. 

  160.      *          following messages defined in org.osid.grading.GradingException
    161. 

  161.      *          may be thrown:  {@link }
    162. 

  162.      *          org.osid.grading.GradingException#OPERATION_FAILED
    163. 

  163.      *          OPERATION_FAILED}, {@link }
    164. 

  164.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    165. 

  165.      *          PERMISSION_DENIED}, {@link }
    166. 

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

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

  168.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    169. 

  169.      * 
    170. 

  170.      * @access public
    171. 

  171.      */
    172. 

  172.     function getExternalReference () { 
    173. 

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

  174.     } 
    175. 

  175.  
    176. 

  176.     /**
    177. 

  177.      * Get the GradeType associated with the GradableObject and Grade.
    178. 

  178.      *  
    179. 

  179.      * @return object Type 
    180. 

  180.      * 
    181. 

  181.      * @throws object GradingException An exception with one of the
    182. 

  182.      *          following messages defined in org.osid.grading.GradingException
    183. 

  183.      *          may be thrown:  {@link }
    184. 

  184.      *          org.osid.grading.GradingException#OPERATION_FAILED
    185. 

  185.      *          OPERATION_FAILED}, {@link }
    186. 

  186.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    187. 

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

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

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

  190.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    191. 

  191.      * 
    192. 

  192.      * @access public
    193. 

  193.      */
    194. 

  194.     function getGradeType () { 
    195. 

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

  196.     } 
    197. 

  197.  
    198. 

  198.     /**
    199. 

  199.      * Get the ScoringDefinition associated with the GradableObject and Grade.
    200. 

  200.      *  
    201. 

  201.      * @return object Type 
    202. 

  202.      * 
    203. 

  203.      * @throws object GradingException An exception with one of the
    204. 

  204.      *          following messages defined in org.osid.grading.GradingException
    205. 

  205.      *          may be thrown:  {@link }
    206. 

  206.      *          org.osid.grading.GradingException#OPERATION_FAILED
    207. 

  207.      *          OPERATION_FAILED}, {@link }
    208. 

  208.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    209. 

  209.      *          PERMISSION_DENIED}, {@link }
    210. 

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

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

  212.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    213. 

  213.      * 
    214. 

  214.      * @access public
    215. 

  215.      */
    216. 

  216.     function getScoringDefinition () { 
    217. 

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

  218.     } 
    219. 

  219.  
    220. 

  220.     /**
    221. 

  221.      * Get the GradeScale associated with the GradableObject and Grade.
    222. 

  222.      *  
    223. 

  223.      * @return object Type 
    224. 

  224.      * 
    225. 

  225.      * @throws object GradingException An exception with one of the
    226. 

  226.      *          following messages defined in org.osid.grading.GradingException
    227. 

  227.      *          may be thrown:  {@link }
    228. 

  228.      *          org.osid.grading.GradingException#OPERATION_FAILED
    229. 

  229.      *          OPERATION_FAILED}, {@link }
    230. 

  230.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    231. 

  231.      *          PERMISSION_DENIED}, {@link }
    232. 

  232.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    233. 

  233.      *          CONFIGURATION_ERROR}, {@link }
    234. 

  234.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    235. 

  235.      * 
    236. 

  236.      * @access public
    237. 

  237.      */
    238. 

  238.     function getGradeScale () { 
    239. 

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

  240.     } 
    241. 

  241.  
    242. 

  242.     /**
    243. 

  243.      * Get the gradeWeight of this GradableObject.
    244. 

  244.      *  
    245. 

  245.      * @return int 
    246. 

  246.      * 
    247. 

  247.      * @throws object GradingException An exception with one of the
    248. 

  248.      *          following messages defined in org.osid.grading.GradingException
    249. 

  249.      *          may be thrown:  {@link }
    250. 

  250.      *          org.osid.grading.GradingException#OPERATION_FAILED
    251. 

  251.      *          OPERATION_FAILED}, {@link }
    252. 

  252.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    253. 

  253.      *          PERMISSION_DENIED}, {@link }
    254. 

  254.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    255. 

  255.      *          CONFIGURATION_ERROR}, {@link }
    256. 

  256.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    257. 

  257.      * 
    258. 

  258.      * @access public
    259. 

  259.      */
    260. 

  260.     function getGradeWeight () { 
    261. 

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

  262.     } 
    263. 

  263.  
    264. 

  264.     /**
    265. 

  265.      * Get the Properties of this Type associated with this GradableObject.
    266. 

  266.      * 
    267. 

  267.      * @param object Type $propertiesType 
    268. 

  268.      *  
    269. 

  269.      * @return object Properties 
    270. 

  270.      * 
    271. 

  271.      * @throws object GradingException An exception with one of the
    272. 

  272.      *          following messages defined in org.osid.grading.GradingException
    273. 

  273.      *          may be thrown:  {@link }
    274. 

  274.      *          org.osid.grading.GradingException#OPERATION_FAILED
    275. 

  275.      *          OPERATION_FAILED}, {@link }
    276. 

  276.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    277. 

  277.      *          PERMISSION_DENIED}, {@link }
    278. 

  278.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    279. 

  279.      *          CONFIGURATION_ERROR}, {@link }
    280. 

  280.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED},
    281. 

  281.      *          {@link org.osid.grading.GradingException#NULL_ARGUMENT}
    282. 

  282.      *          NULL_ARGUMENT}, {@link }
    283. 

  283.      *          org.osid.grading.GradingException#UNKNOWN_TYPE UNKNOWN_TYPE}
    284. 

  284.      * 
    285. 

  285.      * @access public
    286. 

  286.      */
    287. 

  287.     function getPropertiesByType ( $propertiesType ) { 
    288. 

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

  289.     } 
    290. 

  290.  
    291. 

  291.     /**
    292. 

  292.      * Get the Properties Types supported by this GradableObject.
    293. 

  293.      *  
    294. 

  294.      * @return object TypeIterator 
    295. 

  295.      * 
    296. 

  296.      * @throws object GradingException An exception with one of the
    297. 

  297.      *          following messages defined in org.osid.grading.GradingException
    298. 

  298.      *          may be thrown:  {@link }
    299. 

  299.      *          org.osid.grading.GradingException#OPERATION_FAILED
    300. 

  300.      *          OPERATION_FAILED}, {@link }
    301. 

  301.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    302. 

  302.      *          PERMISSION_DENIED}, {@link }
    303. 

  303.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    304. 

  304.      *          CONFIGURATION_ERROR}, {@link }
    305. 

  305.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    306. 

  306.      * 
    307. 

  307.      * @access public
    308. 

  308.      */
    309. 

  309.     function getPropertyTypes () { 
    310. 

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

  311.     } 
    312. 

  312.  
    313. 

  313.     /**
    314. 

  314.      * Get the Properties associated with this GradableObject.
    315. 

  315.      *  
    316. 

  316.      * @return object PropertiesIterator 
    317. 

  317.      * 
    318. 

  318.      * @throws object GradingException An exception with one of the
    319. 

  319.      *          following messages defined in org.osid.grading.GradingException
    320. 

  320.      *          may be thrown:  {@link }
    321. 

  321.      *          org.osid.grading.GradingException#OPERATION_FAILED
    322. 

  322.      *          OPERATION_FAILED}, {@link }
    323. 

  323.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    324. 

  324.      *          PERMISSION_DENIED}, {@link }
    325. 

  325.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    326. 

  326.      *          CONFIGURATION_ERROR}, {@link }
    327. 

  327.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    328. 

  328.      * 
    329. 

  329.      * @access public
    330. 

  330.      */
    331. 

  331.     function getProperties () { 
    332. 

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

  333.     } 
    334. 

  334.  
    335. 

  335.     /**
    336. 

  336.      * Get the Id of the Agent who modified this GradeRecord.
    337. 

  337.      *  
    338. 

  338.      * @return object Id 
    339. 

  339.      * 
    340. 

  340.      * @throws object GradingException An exception with one of the
    341. 

  341.      *          following messages defined in org.osid.grading.GradingException
    342. 

  342.      *          may be thrown:   {@link }
    343. 

  343.      *          org.osid.grading.GradingException#OPERATION_FAILED
    344. 

  344.      *          OPERATION_FAILED}, {@link }
    345. 

  345.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    346. 

  346.      *          PERMISSION_DENIED}, {@link }
    347. 

  347.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    348. 

  348.      *          CONFIGURATION_ERROR}, {@link }
    349. 

  349.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    350. 

  350.      * 
    351. 

  351.      * @access public
    352. 

  352.      */
    353. 

  353.     function getModifiedBy () { 
    354. 

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

  355.     } 
    356. 

  356.  
    357. 

  357.     /**
    358. 

  358.      * Get the date when this GradeRecord was modified.
    359. 

  359.      *  
    360. 

  360.      * @return int 
    361. 

  361.      * 
    362. 

  362.      * @throws object GradingException An exception with one of the
    363. 

  363.      *          following messages defined in org.osid.grading.GradingException
    364. 

  364.      *          may be thrown:   {@link }
    365. 

  365.      *          org.osid.grading.GradingException#OPERATION_FAILED
    366. 

  366.      *          OPERATION_FAILED}, {@link }
    367. 

  367.      *          org.osid.grading.GradingException#PERMISSION_DENIED
    368. 

  368.      *          PERMISSION_DENIED}, {@link }
    369. 

  369.      *          org.osid.grading.GradingException#CONFIGURATION_ERROR
    370. 

  370.      *          CONFIGURATION_ERROR}, {@link }
    371. 

  371.      *          org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
    372. 

  372.      * 
    373. 

  373.      * @access public
    374. 

  374.      */
    375. 

  375.     function getModifiedDate () { 
    376. 

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

  377.     } 
    378. 

  378. }
    379. 

  379.  
    380. 

  380. ?>
    381.

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