Source for file CourseSection.php

Documentation is available at CourseSection.php

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

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