Source for file CourseGradeRecord.php

Documentation is available at CourseGradeRecord.php

  1. <?php
  2. /**
  3. * CourseGradeRecord manages the CourseGrade of a specific CourseGradeType for
  4. * an Agent and a CourseOffering.
  5. *
  6. * <p>
  7. * OSID Version: 2.0
  8. * </p>
  9. *
  10. * <p>
  11. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  12. * O.K.I&#46; OSID Definition License}.
  13. * </p>
  14. *
  15. * @package org.osid.coursemanagement
  16. */
  17. class CourseGradeRecord
  18. {
  19. /**
  20. * Update the grade for this CourseGradeRecord.
  21. *
  22. * @param object mixed $courseGrade (original type: java.io.Serializable)
  23. *
  24. * @throws object CourseManagementException An exception
  25. * with one of the following messages defined in
  26. * org.osid.coursemanagement.CourseManagementException may be
  27. * thrown: {@link }
  28. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  29. * OPERATION_FAILED}, {@link }
  30. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  31. * PERMISSION_DENIED}, {@link }
  32. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  33. * CONFIGURATION_ERROR}, {@link }
  34. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  35. * UNIMPLEMENTED}, {@link }
  36. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  37. * NULL_ARGUMENT}
  38. *
  39. * @access public
  40. */
  41. function updateCourseGrade ( $courseGrade ) {
  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 display name for this CourseGradeRecord.
  47. *
  48. * @param string $displayName
  49. *
  50. * @throws object CourseManagementException An exception
  51. * with one of the following messages defined in
  52. * org.osid.coursemanagement.CourseManagementException may be
  53. * thrown: {@link }
  54. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  55. * OPERATION_FAILED}, {@link }
  56. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  57. * PERMISSION_DENIED}, {@link }
  58. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  59. * CONFIGURATION_ERROR}, {@link }
  60. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  61. * UNIMPLEMENTED}, {@link }
  62. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  63. * NULL_ARGUMENT}
  64. *
  65. * @access public
  66. */
  67. function updateDisplayName ( $displayName ) {
  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 grade for this CourseGradeRecord.
  73. *
  74. * @return object mixed (original type: java.io.Serializable)
  75. *
  76. * @throws object CourseManagementException An exception
  77. * with one of the following messages defined in
  78. * org.osid.coursemanagement.CourseManagementException may be
  79. * thrown: {@link }
  80. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  81. * OPERATION_FAILED}, {@link }
  82. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  83. * PERMISSION_DENIED}, {@link }
  84. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  85. * CONFIGURATION_ERROR}, {@link }
  86. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  87. * UNIMPLEMENTED}
  88. *
  89. * @access public
  90. */
  91. function getCourseGrade () {
  92. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  93. }
  94.  
  95. /**
  96. * Get the display name for this CourseGradeRecord.
  97. *
  98. * @return string
  99. *
  100. * @throws object CourseManagementException An exception
  101. * with one of the following messages defined in
  102. * org.osid.coursemanagement.CourseManagementException may be
  103. * thrown: {@link }
  104. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  105. * OPERATION_FAILED}, {@link }
  106. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  107. * PERMISSION_DENIED}, {@link }
  108. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  109. * CONFIGURATION_ERROR}, {@link }
  110. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  111. * UNIMPLEMENTED}
  112. *
  113. * @access public
  114. */
  115. function getDisplayName () {
  116. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  117. }
  118.  
  119. /**
  120. * Get the unique Id for this CourseGradeRecord.
  121. *
  122. * @return object Id
  123. *
  124. * @throws object CourseManagementException An exception
  125. * with one of the following messages defined in
  126. * org.osid.coursemanagement.CourseManagementException may be
  127. * thrown: {@link }
  128. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  129. * OPERATION_FAILED}, {@link }
  130. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  131. * PERMISSION_DENIED}, {@link }
  132. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  133. * CONFIGURATION_ERROR}, {@link }
  134. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  135. * UNIMPLEMENTED}
  136. *
  137. * @access public
  138. */
  139. function getId () {
  140. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  141. }
  142.  
  143. /**
  144. * Get the Agent (student) associated with this CourseGradeRecord.
  145. *
  146. * @return object Id
  147. *
  148. * @throws object CourseManagementException An exception
  149. * with one of the following messages defined in
  150. * org.osid.coursemanagement.CourseManagementException may be
  151. * thrown: {@link }
  152. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  153. * OPERATION_FAILED}, {@link }
  154. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  155. * PERMISSION_DENIED}, {@link }
  156. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  157. * CONFIGURATION_ERROR}, {@link }
  158. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  159. * UNIMPLEMENTED}
  160. *
  161. * @access public
  162. */
  163. function getStudent () {
  164. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  165. }
  166.  
  167. /**
  168. * Get the CourseGradeType for this Offering. GradingType is defined in
  169. * the grading OSID. These Types are meaningful to the implementation and
  170. * applications and are not specified by the OSID.
  171. *
  172. * @return object Type
  173. *
  174. * @throws object CourseManagementException An exception
  175. * with one of the following messages defined in
  176. * org.osid.coursemanagement.CourseManagementException may be
  177. * thrown: {@link }
  178. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  179. * OPERATION_FAILED}, {@link }
  180. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  181. * PERMISSION_DENIED}, {@link }
  182. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  183. * CONFIGURATION_ERROR}, {@link }
  184. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  185. * UNIMPLEMENTED}
  186. *
  187. * @access public
  188. */
  189. function getCourseGradeType () {
  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 the unique Id for the CourseOffering for this CourseGradeRecord..
  195. *
  196. * @return object Id
  197. *
  198. * @throws object CourseManagementException An exception
  199. * with one of the following messages defined in
  200. * org.osid.coursemanagement.CourseManagementException may be
  201. * thrown: {@link }
  202. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  203. * OPERATION_FAILED}, {@link }
  204. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  205. * PERMISSION_DENIED}, {@link }
  206. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  207. * CONFIGURATION_ERROR}, {@link }
  208. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  209. * UNIMPLEMENTED}
  210. *
  211. * @access public
  212. */
  213. function getCourseOffering () {
  214. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  215. }
  216. }
  217.  
  218. ?>

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