Source for file CourseOffering.php

Documentation is available at CourseOffering.php

  1. <?php
  2. /**
  3. * CourseOffering is a CanonicalCourse offered in a specific Term.
  4. * CanonicalCourse contains general information about a course in general.
  5. * The CourseSection is the third and most specific course-related object.
  6. * The section includes information about the location of the class as well as
  7. * the roster of students. CanonicalCourses can contain other
  8. * CanonicalCourses and may be organized hierarchically, in schools,
  9. * departments, for majors, and so on. For each CanonicalCourse, there are
  10. * zero or more offerings and for each offering, zero or more sections. All
  11. * three levels have separate data for Title, Number, Description, and Id.
  12. * This information can be the same or different as implementations choose and
  13. * applications require.
  14. *
  15. * <p>
  16. * OSID Version: 2.0
  17. * </p>
  18. *
  19. * <p>
  20. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  21. * O.K.I&#46; OSID Definition License}.
  22. * </p>
  23. *
  24. * @package org.osid.coursemanagement
  25. */
  26. class CourseOffering
  27. {
  28. /**
  29. * Update the title for this CourseOffering.
  30. *
  31. * @param string $title
  32. *
  33. * @throws object CourseManagementException An exception
  34. * with one of the following messages defined in
  35. * org.osid.coursemanagement.CourseManagementException may be
  36. * thrown: {@link }
  37. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  38. * OPERATION_FAILED}, {@link }
  39. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  40. * PERMISSION_DENIED}, {@link }
  41. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  42. * CONFIGURATION_ERROR}, {@link }
  43. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  44. * UNIMPLEMENTED}, {@link }
  45. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  46. * NULL_ARGUMENT}
  47. *
  48. * @access public
  49. */
  50. function updateTitle ( $title ) {
  51. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  52. }
  53.  
  54. /**
  55. * Update the number for this CourseOffering.
  56. *
  57. * @param string $number
  58. *
  59. * @throws object CourseManagementException An exception
  60. * with one of the following messages defined in
  61. * org.osid.coursemanagement.CourseManagementException may be
  62. * thrown: {@link }
  63. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  64. * OPERATION_FAILED}, {@link }
  65. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  66. * PERMISSION_DENIED}, {@link }
  67. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  68. * CONFIGURATION_ERROR}, {@link }
  69. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  70. * UNIMPLEMENTED}, {@link }
  71. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  72. * NULL_ARGUMENT}
  73. *
  74. * @access public
  75. */
  76. function updateNumber ( $number ) {
  77. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  78. }
  79.  
  80. /**
  81. * Update the description for this CourseOffering.
  82. *
  83. * @param string $description
  84. *
  85. * @throws object CourseManagementException An exception
  86. * with one of the following messages defined in
  87. * org.osid.coursemanagement.CourseManagementException may be
  88. * thrown: {@link }
  89. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  90. * OPERATION_FAILED}, {@link }
  91. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  92. * PERMISSION_DENIED}, {@link }
  93. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  94. * CONFIGURATION_ERROR}, {@link }
  95. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  96. * UNIMPLEMENTED}, {@link }
  97. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  98. * NULL_ARGUMENT}
  99. *
  100. * @access public
  101. */
  102. function updateDescription ( $description ) {
  103. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  104. }
  105.  
  106. /**
  107. * Update the display name for this CourseOffering.
  108. *
  109. * @param string $displayName
  110. *
  111. * @throws object CourseManagementException An exception
  112. * with one of the following messages defined in
  113. * org.osid.coursemanagement.CourseManagementException may be
  114. * thrown: {@link }
  115. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  116. * OPERATION_FAILED}, {@link }
  117. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  118. * PERMISSION_DENIED}, {@link }
  119. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  120. * CONFIGURATION_ERROR}, {@link }
  121. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  122. * UNIMPLEMENTED}, {@link }
  123. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  124. * NULL_ARGUMENT}
  125. *
  126. * @access public
  127. */
  128. function updateDisplayName ( $displayName ) {
  129. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  130. }
  131.  
  132. /**
  133. * Get the title for this CourseOffering.
  134. *
  135. * @return string
  136. *
  137. * @throws object CourseManagementException An exception
  138. * with one of the following messages defined in
  139. * org.osid.coursemanagement.CourseManagementException may be
  140. * thrown: {@link }
  141. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  142. * OPERATION_FAILED}, {@link }
  143. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  144. * PERMISSION_DENIED}, {@link }
  145. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  146. * CONFIGURATION_ERROR}, {@link }
  147. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  148. * UNIMPLEMENTED}
  149. *
  150. * @access public
  151. */
  152. function getTitle () {
  153. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  154. }
  155.  
  156. /**
  157. * Get the number for this CourseOffering.
  158. *
  159. * @return string
  160. *
  161. * @throws object CourseManagementException An exception
  162. * with one of the following messages defined in
  163. * org.osid.coursemanagement.CourseManagementException may be
  164. * thrown: {@link }
  165. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  166. * OPERATION_FAILED}, {@link }
  167. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  168. * PERMISSION_DENIED}, {@link }
  169. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  170. * CONFIGURATION_ERROR}, {@link }
  171. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  172. * UNIMPLEMENTED}
  173. *
  174. * @access public
  175. */
  176. function getNumber () {
  177. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  178. }
  179.  
  180. /**
  181. * Get the description for this CourseOffering.
  182. *
  183. * @return string
  184. *
  185. * @throws object CourseManagementException An exception
  186. * with one of the following messages defined in
  187. * org.osid.coursemanagement.CourseManagementException may be
  188. * thrown: {@link }
  189. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  190. * OPERATION_FAILED}, {@link }
  191. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  192. * PERMISSION_DENIED}, {@link }
  193. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  194. * CONFIGURATION_ERROR}, {@link }
  195. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  196. * UNIMPLEMENTED}
  197. *
  198. * @access public
  199. */
  200. function getDescription () {
  201. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  202. }
  203.  
  204. /**
  205. * Get the display name for this CourseOffering.
  206. *
  207. * @return string
  208. *
  209. * @throws object CourseManagementException An exception
  210. * with one of the following messages defined in
  211. * org.osid.coursemanagement.CourseManagementException may be
  212. * thrown: {@link }
  213. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  214. * OPERATION_FAILED}, {@link }
  215. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  216. * PERMISSION_DENIED}, {@link }
  217. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  218. * CONFIGURATION_ERROR}, {@link }
  219. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  220. * UNIMPLEMENTED}
  221. *
  222. * @access public
  223. */
  224. function getDisplayName () {
  225. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  226. }
  227.  
  228. /**
  229. * Get the unique Id for this CourseOffering.
  230. *
  231. * @return object Id
  232. *
  233. * @throws object CourseManagementException An exception
  234. * with one of the following messages defined in
  235. * org.osid.coursemanagement.CourseManagementException may be
  236. * thrown: {@link }
  237. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  238. * OPERATION_FAILED}, {@link }
  239. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  240. * PERMISSION_DENIED}, {@link }
  241. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  242. * CONFIGURATION_ERROR}, {@link }
  243. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  244. * UNIMPLEMENTED}
  245. *
  246. * @access public
  247. */
  248. function getId () {
  249. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  250. }
  251.  
  252. /**
  253. * Get the Offering Type for this CourseOffering. This Type is meaningful
  254. * to the implementation and applications and are not specified by the
  255. * OSID.
  256. *
  257. * @return object Type
  258. *
  259. * @throws object CourseManagementException An exception
  260. * with one of the following messages defined in
  261. * org.osid.coursemanagement.CourseManagementException may be
  262. * thrown: {@link }
  263. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  264. * OPERATION_FAILED}, {@link }
  265. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  266. * PERMISSION_DENIED}, {@link }
  267. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  268. * CONFIGURATION_ERROR}, {@link }
  269. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  270. * UNIMPLEMENTED}
  271. *
  272. * @access public
  273. */
  274. function getOfferingType () {
  275. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  276. }
  277.  
  278. /**
  279. * Get the CourseGradeType for this Offering. GradingType is defined in
  280. * the grading OSID. These Types are meaningful to the implementation and
  281. * applications and are not specified by the OSID.
  282. *
  283. * @return object Type
  284. *
  285. * @throws object CourseManagementException An exception
  286. * with one of the following messages defined in
  287. * org.osid.coursemanagement.CourseManagementException may be
  288. * thrown: {@link }
  289. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  290. * OPERATION_FAILED}, {@link }
  291. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  292. * PERMISSION_DENIED}, {@link }
  293. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  294. * CONFIGURATION_ERROR}, {@link }
  295. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  296. * UNIMPLEMENTED}
  297. *
  298. * @access public
  299. */
  300. function getCourseGradeType () {
  301. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  302. }
  303.  
  304. /**
  305. * Get a Term by unique Id.
  306. *
  307. * @return object Term
  308. *
  309. * @throws object CourseManagementException An exception
  310. * with one of the following messages defined in
  311. * org.osid.coursemanagement.CourseManagementException may be
  312. * thrown: {@link }
  313. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  314. * OPERATION_FAILED}, {@link }
  315. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  316. * PERMISSION_DENIED}, {@link }
  317. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  318. * CONFIGURATION_ERROR}, {@link }
  319. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  320. * UNIMPLEMENTED}
  321. *
  322. * @access public
  323. */
  324. function getTerm () {
  325. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  326. }
  327.  
  328. /**
  329. * Get the Status for this CanonicalCourse.
  330. *
  331. * @return object Type
  332. *
  333. * @throws object CourseManagementException An exception
  334. * with one of the following messages defined in
  335. * org.osid.coursemanagement.CourseManagementException may be
  336. * thrown: {@link }
  337. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  338. * OPERATION_FAILED}, {@link }
  339. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  340. * PERMISSION_DENIED}, {@link }
  341. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  342. * CONFIGURATION_ERROR}, {@link }
  343. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  344. * UNIMPLEMENTED}
  345. *
  346. * @access public
  347. */
  348. function getStatus () {
  349. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  350. }
  351.  
  352. /**
  353. * Get all the Property Types for CourseOffering.
  354. *
  355. * @return object TypeIterator
  356. *
  357. * @throws object CourseManagementException An exception
  358. * with one of the following messages defined in
  359. * org.osid.coursemanagement.CourseManagementException may be
  360. * thrown: {@link }
  361. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  362. * OPERATION_FAILED}, {@link }
  363. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  364. * PERMISSION_DENIED}, {@link }
  365. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  366. * CONFIGURATION_ERROR}, {@link }
  367. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  368. * UNIMPLEMENTED}
  369. *
  370. * @access public
  371. */
  372. function getPropertyTypes () {
  373. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  374. }
  375.  
  376. /**
  377. * Get the Properties associated with this CourseOffering.
  378. *
  379. * @return object PropertiesIterator
  380. *
  381. * @throws object CourseManagementException An exception
  382. * with one of the following messages defined in
  383. * org.osid.coursemanagement.CourseManagementException may be
  384. * thrown: {@link }
  385. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  386. * OPERATION_FAILED}, {@link }
  387. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  388. * PERMISSION_DENIED}, {@link }
  389. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  390. * CONFIGURATION_ERROR}, {@link }
  391. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  392. * UNIMPLEMENTED}
  393. *
  394. * @access public
  395. */
  396. function getProperties () {
  397. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  398. }
  399.  
  400. /**
  401. * Get the CanonicalCourse that contains this CourseOffering.
  402. *
  403. * @return object CanonicalCourse
  404. *
  405. * @throws object CourseManagementException An exception
  406. * with one of the following messages defined in
  407. * org.osid.coursemanagement.CourseManagementException may be
  408. * thrown: {@link }
  409. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  410. * OPERATION_FAILED}, {@link }
  411. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  412. * PERMISSION_DENIED}, {@link }
  413. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  414. * CONFIGURATION_ERROR}, {@link }
  415. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  416. * UNIMPLEMENTED}
  417. *
  418. * @access public
  419. */
  420. function getCanonicalCourse () {
  421. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  422. }
  423.  
  424. /**
  425. * Create a new CourseSection.
  426. *
  427. * @param string $title
  428. * @param string $number
  429. * @param string $description
  430. * @param object Type $sectionType
  431. * @param object Type $sectionStatusType
  432. * @param object mixed $location (original type: java.io.Serializable)
  433. *
  434. * @return object CourseSection
  435. *
  436. * @throws object CourseManagementException An exception
  437. * with one of the following messages defined in
  438. * org.osid.coursemanagement.CourseManagementException may be
  439. * thrown: {@link }
  440. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  441. * OPERATION_FAILED}, {@link }
  442. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  443. * PERMISSION_DENIED}, {@link }
  444. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  445. * CONFIGURATION_ERROR}, {@link }
  446. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  447. * UNIMPLEMENTED}, {@link }
  448. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  449. * NULL_ARGUMENT}, {@link }
  450. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  451. * UNKNOWN_TYPE}
  452. *
  453. * @access public
  454. */
  455. function createCourseSection ( $title, $number, $description, $sectionType, $sectionStatusType, $location ) {
  456. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  457. }
  458.  
  459. /**
  460. * Delete a CourseSection.
  461. *
  462. * @param object Id $courseSectionId
  463. *
  464. * @throws object CourseManagementException An exception
  465. * with one of the following messages defined in
  466. * org.osid.coursemanagement.CourseManagementException may be
  467. * thrown: {@link }
  468. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  469. * OPERATION_FAILED}, {@link }
  470. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  471. * PERMISSION_DENIED}, {@link }
  472. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  473. * CONFIGURATION_ERROR}, {@link }
  474. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  475. * UNIMPLEMENTED}, {@link }
  476. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  477. * NULL_ARGUMENT}, {@link }
  478. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_ID
  479. * UNKNOWN_ID}
  480. *
  481. * @access public
  482. */
  483. function deleteCourseSection ( $courseSectionId ) {
  484. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  485. }
  486.  
  487. /**
  488. * Get all CourseSections.
  489. *
  490. * @return object CourseSectionIterator
  491. *
  492. * @throws object CourseManagementException An exception
  493. * with one of the following messages defined in
  494. * org.osid.coursemanagement.CourseManagementException may be
  495. * thrown: {@link }
  496. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  497. * OPERATION_FAILED}, {@link }
  498. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  499. * PERMISSION_DENIED}, {@link }
  500. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  501. * CONFIGURATION_ERROR}, {@link }
  502. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  503. * UNIMPLEMENTED}
  504. *
  505. * @access public
  506. */
  507. function getCourseSections () {
  508. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  509. }
  510.  
  511. /**
  512. * Get all CourseSections of the specified Type.
  513. *
  514. * @param object Type $sectionType
  515. *
  516. * @return object CourseSectionIterator
  517. *
  518. * @throws object CourseManagementException An exception
  519. * with one of the following messages defined in
  520. * org.osid.coursemanagement.CourseManagementException may be
  521. * thrown: {@link }
  522. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  523. * OPERATION_FAILED}, {@link }
  524. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  525. * PERMISSION_DENIED}, {@link }
  526. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  527. * CONFIGURATION_ERROR}, {@link }
  528. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  529. * UNIMPLEMENTED}, {@link }
  530. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  531. * NULL_ARGUMENT}, {@link }
  532. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  533. * UNKNOWN_TYPE}
  534. *
  535. * @access public
  536. */
  537. function getCourseSectionsByType ( $sectionType ) {
  538. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  539. }
  540.  
  541. /**
  542. * Add an Asset for this CourseOffering.
  543. *
  544. * @param object Id $assetId
  545. *
  546. * @throws object CourseManagementException An exception
  547. * with one of the following messages defined in
  548. * org.osid.coursemanagement.CourseManagementException may be
  549. * thrown: {@link }
  550. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  551. * OPERATION_FAILED}, {@link }
  552. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  553. * PERMISSION_DENIED}, {@link }
  554. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  555. * CONFIGURATION_ERROR}, {@link }
  556. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  557. * UNIMPLEMENTED}, {@link }
  558. * org.osid.coursemanagement.CourseManagementException#ALREADY_ADDED
  559. * ALREADY_ADDED}
  560. *
  561. * @access public
  562. */
  563. function addAsset ( $assetId ) {
  564. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  565. }
  566.  
  567. /**
  568. * Remove an Asset for this CourseOffering.
  569. *
  570. * @param object Id $assetId
  571. *
  572. * @throws object CourseManagementException An exception
  573. * with one of the following messages defined in
  574. * org.osid.coursemanagement.CourseManagementException may be
  575. * thrown: {@link }
  576. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  577. * OPERATION_FAILED}, {@link }
  578. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  579. * PERMISSION_DENIED}, {@link }
  580. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  581. * CONFIGURATION_ERROR}, {@link }
  582. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  583. * UNIMPLEMENTED}, {@link }
  584. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  585. * NULL_ARGUMENT}, {@link }
  586. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_ID
  587. * UNKNOWN_ID}
  588. *
  589. * @access public
  590. */
  591. function removeAsset ( $assetId ) {
  592. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  593. }
  594.  
  595. /**
  596. * Get the Assets associated with this CourseOffering.
  597. *
  598. * @return object IdIterator
  599. *
  600. * @throws object CourseManagementException An exception
  601. * with one of the following messages defined in
  602. * org.osid.coursemanagement.CourseManagementException may be
  603. * thrown: {@link }
  604. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  605. * OPERATION_FAILED}, {@link }
  606. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  607. * PERMISSION_DENIED}, {@link }
  608. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  609. * CONFIGURATION_ERROR}, {@link }
  610. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  611. * UNIMPLEMENTED}
  612. *
  613. * @access public
  614. */
  615. function getAssets () {
  616. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  617. }
  618.  
  619. /**
  620. * Update the CourseGradeType for this Offering. GradingType is defined in
  621. * the grading OSID. These Types are meaningful to the implementation and
  622. * applications and are not specified by the OSID.
  623. *
  624. * @param object Type $courseGradeType
  625. *
  626. * @throws object CourseManagementException An exception
  627. * with one of the following messages defined in
  628. * org.osid.coursemanagement.CourseManagementException may be
  629. * thrown: {@link }
  630. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  631. * OPERATION_FAILED}, {@link }
  632. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  633. * PERMISSION_DENIED}, {@link }
  634. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  635. * CONFIGURATION_ERROR}, {@link }
  636. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  637. * UNIMPLEMENTED}, {@link }
  638. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  639. * NULL_ARGUMENT}, {@link }
  640. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  641. * UNKNOWN_TYPE}
  642. *
  643. * @access public
  644. */
  645. function updateCourseGradeType ( $courseGradeType ) {
  646. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  647. }
  648.  
  649. /**
  650. * Update the Status for this CanonicalCourse.
  651. *
  652. * @param object Type $statusType
  653. *
  654. * @throws object CourseManagementException An exception
  655. * with one of the following messages defined in
  656. * org.osid.coursemanagement.CourseManagementException may be
  657. * thrown: {@link }
  658. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  659. * OPERATION_FAILED}, {@link }
  660. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  661. * PERMISSION_DENIED}, {@link }
  662. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  663. * CONFIGURATION_ERROR}, {@link }
  664. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  665. * UNIMPLEMENTED}, {@link }
  666. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  667. * NULL_ARGUMENT}, {@link }
  668. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  669. * UNKNOWN_TYPE}
  670. *
  671. * @access public
  672. */
  673. function updateStatus ( $statusType ) {
  674. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  675. }
  676.  
  677. /**
  678. * Add a student to the roster and assign the specified Enrollment Status
  679. * Type.
  680. *
  681. * @param object Id $agentId
  682. * @param object Type $enrollmentStatusType
  683. *
  684. * @throws object CourseManagementException An exception
  685. * with one of the following messages defined in
  686. * org.osid.coursemanagement.CourseManagementException may be
  687. * thrown: {@link }
  688. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  689. * OPERATION_FAILED}, {@link }
  690. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  691. * PERMISSION_DENIED}, {@link }
  692. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  693. * CONFIGURATION_ERROR}, {@link }
  694. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  695. * UNIMPLEMENTED}, {@link }
  696. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  697. * NULL_ARGUMENT}, {@link }
  698. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  699. * UNKNOWN_TYPE}, {@link }
  700. * org.osid.coursemanagement.CourseManagementException#ALREADY_ADDED
  701. * ALREADY_ADDED}
  702. *
  703. * @access public
  704. */
  705. function addStudent ( $agentId, $enrollmentStatusType ) {
  706. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  707. }
  708.  
  709. /**
  710. * Change the Enrollment Status Type for the student on the roster.
  711. *
  712. * @param object Id $agentId
  713. * @param object Type $enrollmentStatusType
  714. *
  715. * @throws object CourseManagementException An exception
  716. * with one of the following messages defined in
  717. * org.osid.coursemanagement.CourseManagementException may be
  718. * thrown: {@link }
  719. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  720. * OPERATION_FAILED}, {@link }
  721. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  722. * PERMISSION_DENIED}, {@link }
  723. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  724. * CONFIGURATION_ERROR}, {@link }
  725. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  726. * UNIMPLEMENTED}, {@link }
  727. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  728. * NULL_ARGUMENT}, {@link }
  729. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  730. * UNKNOWN_TYPE}
  731. *
  732. * @access public
  733. */
  734. function changeStudent ( $agentId, $enrollmentStatusType ) {
  735. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  736. }
  737.  
  738. /**
  739. * Remove a student from the roster.
  740. *
  741. * @param object Id $agentId
  742. *
  743. * @throws object CourseManagementException An exception
  744. * with one of the following messages defined in
  745. * org.osid.coursemanagement.CourseManagementException may be
  746. * thrown: {@link }
  747. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  748. * OPERATION_FAILED}, {@link }
  749. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  750. * PERMISSION_DENIED}, {@link }
  751. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  752. * CONFIGURATION_ERROR}, {@link }
  753. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  754. * UNIMPLEMENTED}, {@link }
  755. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  756. * NULL_ARGUMENT}, {@link }
  757. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_ID
  758. * UNKNOWN_ID}
  759. *
  760. * @access public
  761. */
  762. function removeStudent ( $agentId ) {
  763. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  764. }
  765.  
  766. /**
  767. * Get the student roster.
  768. *
  769. * @return object EnrollmentRecordIterator
  770. *
  771. * @throws object CourseManagementException An exception
  772. * with one of the following messages defined in
  773. * org.osid.coursemanagement.CourseManagementException may be
  774. * thrown: {@link }
  775. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  776. * OPERATION_FAILED}, {@link }
  777. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  778. * PERMISSION_DENIED}, {@link }
  779. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  780. * CONFIGURATION_ERROR}, {@link }
  781. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  782. * UNIMPLEMENTED}
  783. *
  784. * @access public
  785. */
  786. function getRoster () {
  787. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  788. }
  789.  
  790. /**
  791. * Get the student roster. Include only students with the specified
  792. * Enrollment Status Type.
  793. *
  794. * @param object Type $enrollmentStatusType
  795. *
  796. * @return object EnrollmentRecordIterator
  797. *
  798. * @throws object CourseManagementException An exception
  799. * with one of the following messages defined in
  800. * org.osid.coursemanagement.CourseManagementException may be
  801. * thrown: {@link }
  802. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  803. * OPERATION_FAILED}, {@link }
  804. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  805. * PERMISSION_DENIED}, {@link }
  806. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  807. * CONFIGURATION_ERROR}, {@link }
  808. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  809. * UNIMPLEMENTED}, {@link }
  810. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  811. * NULL_ARGUMENT}, {@link }
  812. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  813. * UNKNOWN_TYPE}
  814. *
  815. * @access public
  816. */
  817. function getRosterByType ( $enrollmentStatusType ) {
  818. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  819. }
  820.  
  821. /**
  822. * Get the Properties of this Type associated with this CourseOffering.
  823. *
  824. * @param object Type $propertiesType
  825. *
  826. * @return object Properties
  827. *
  828. * @throws object CourseManagementException An exception
  829. * with one of the following messages defined in
  830. * org.osid.coursemanagement.CourseManagementException may be
  831. * thrown: {@link }
  832. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  833. * OPERATION_FAILED}, {@link }
  834. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  835. * PERMISSION_DENIED}, {@link }
  836. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  837. * CONFIGURATION_ERROR}, {@link }
  838. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  839. * UNIMPLEMENTED}, {@link }
  840. * org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
  841. * NULL_ARGUMENT}, {@link }
  842. * org.osid.coursemanagement.CourseManagementException#UNKNOWN_TYPE
  843. * UNKNOWN_TYPE}
  844. *
  845. * @access public
  846. */
  847. function getPropertiesByType ( $propertiesType ) {
  848. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  849. }
  850. }
  851.  
  852. ?>

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