Source for file Term.php

Documentation is available at Term.php

  1. <?php
  2. /**
  3. * Term includes an unique Id assigned by the implementation, a display name, a
  4. * termType, and a schedule.
  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 Term
  18. {
  19. /**
  20. * Update the display name for this Term.
  21. *
  22. * @param string $displayName
  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 updateDisplayName ( $displayName ) {
  42. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  43. }
  44.  
  45. /**
  46. * Get the display name for this Term.
  47. *
  48. * @return string
  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}
  62. *
  63. * @access public
  64. */
  65. function getDisplayName () {
  66. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  67. }
  68.  
  69. /**
  70. * Get the unique Id for this Term.
  71. *
  72. * @return object Id
  73. *
  74. * @throws object CourseManagementException An exception
  75. * with one of the following messages defined in
  76. * org.osid.coursemanagement.CourseManagementException may be
  77. * thrown: {@link }
  78. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  79. * OPERATION_FAILED}, {@link }
  80. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  81. * PERMISSION_DENIED}, {@link }
  82. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  83. * CONFIGURATION_ERROR}, {@link }
  84. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  85. * UNIMPLEMENTED}
  86. *
  87. * @access public
  88. */
  89. function getId () {
  90. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  91. }
  92.  
  93. /**
  94. * Get the Type for this Term. This Type is meaningful to the
  95. * implementation and applications and is not specified by the OSID.
  96. *
  97. * @return object Type
  98. *
  99. * @throws object CourseManagementException An exception
  100. * with one of the following messages defined in
  101. * org.osid.coursemanagement.CourseManagementException may be
  102. * thrown: {@link }
  103. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  104. * OPERATION_FAILED}, {@link }
  105. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  106. * PERMISSION_DENIED}, {@link }
  107. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  108. * CONFIGURATION_ERROR}, {@link }
  109. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  110. * UNIMPLEMENTED}
  111. *
  112. * @access public
  113. */
  114. function getType () {
  115. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  116. }
  117.  
  118. /**
  119. * Get the Schedule for this Term. Schedules are defined in scheduling
  120. * OSID. ScheduleItems are returned in chronological order by increasing
  121. * start date.
  122. *
  123. * @return object ScheduleItemIterator
  124. *
  125. * @throws object CourseManagementException An exception
  126. * with one of the following messages defined in
  127. * org.osid.coursemanagement.CourseManagementException may be
  128. * thrown: {@link }
  129. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  130. * OPERATION_FAILED}, {@link }
  131. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  132. * PERMISSION_DENIED}, {@link }
  133. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  134. * CONFIGURATION_ERROR}, {@link }
  135. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  136. * UNIMPLEMENTED}
  137. *
  138. * @access public
  139. */
  140. function getSchedule () {
  141. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  142. }
  143. }
  144.  
  145. ?>

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