Source for file Assessment.php

Documentation is available at Assessment.php

  1. <?php
  2. /**
  3. * Assessment includes zero or more Sections which in turn contain zero or more
  4. * Items. The Sections added to an Assessment are returned first in, first out
  5. * (FIFO). Items can be ordered explicitly using the orderSections method.
  6. * AssessmentType is meaningful to an application and not specifcally defined
  7. * in the OSID. The unique Id for an Item is set by the AssessmentManager's
  8. * createAssessment method's implementation. Assessments also contain a
  9. * Topic. An Assessment is related to a AssessmentPublished which is an
  10. * Assessment and a set of data relating to the availability of the
  11. * Assessment. An Assessment is also related to an AssessmentTaken which is
  12. * an Assessment and a set of data relating to an agentId of the student's
  13. * integration with it.
  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.assessment
  25. */
  26. class Assessment
  27. {
  28. /**
  29. * Update the display name for this Assessment.
  30. *
  31. * @param string $displayName
  32. *
  33. * @throws object AssessmentException An exception with one of
  34. * the following messages defined in
  35. * org.osid.assessment.AssessmentException may be thrown: {@link }
  36. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  37. * OPERATION_FAILED}, {@link }
  38. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  39. * PERMISSION_DENIED}, {@link }
  40. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  41. * CONFIGURATION_ERROR}, {@link }
  42. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  43. * UNIMPLEMENTED}, {@link }
  44. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  45. * NULL_ARGUMENT}
  46. *
  47. * @access public
  48. */
  49. function updateDisplayName ( $displayName ) {
  50. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  51. }
  52.  
  53. /**
  54. * Update the description for this Assessment.
  55. *
  56. * @param string $description
  57. *
  58. * @throws object AssessmentException An exception with one of
  59. * the following messages defined in
  60. * org.osid.assessment.AssessmentException may be thrown: {@link }
  61. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  62. * OPERATION_FAILED}, {@link }
  63. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  64. * PERMISSION_DENIED}, {@link }
  65. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  66. * CONFIGURATION_ERROR}, {@link }
  67. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  68. * UNIMPLEMENTED}, {@link }
  69. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  70. * NULL_ARGUMENT}
  71. *
  72. * @access public
  73. */
  74. function updateDescription ( $description ) {
  75. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  76. }
  77.  
  78. /**
  79. * Update the Topic for this Assessment.
  80. *
  81. * @param string $topic
  82. *
  83. * @throws object AssessmentException An exception with one of
  84. * the following messages defined in
  85. * org.osid.assessment.AssessmentException may be thrown: {@link }
  86. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  87. * OPERATION_FAILED}, {@link }
  88. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  89. * PERMISSION_DENIED}, {@link }
  90. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  91. * CONFIGURATION_ERROR}, {@link }
  92. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  93. * UNIMPLEMENTED}, {@link }
  94. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  95. * NULL_ARGUMENT}
  96. *
  97. * @access public
  98. */
  99. function updateTopic ( $topic ) {
  100. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  101. }
  102.  
  103. /**
  104. * Update the data for this Assessment. The structure of the Data is not
  105. * defined in the OSID.
  106. *
  107. * @param object mixed $data (original type: java.io.Serializable)
  108. *
  109. * @throws object AssessmentException An exception with one of
  110. * the following messages defined in
  111. * org.osid.assessment.AssessmentException may be thrown: {@link }
  112. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  113. * OPERATION_FAILED}, {@link }
  114. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  115. * PERMISSION_DENIED}, {@link }
  116. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  117. * CONFIGURATION_ERROR}, {@link }
  118. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  119. * UNIMPLEMENTED}, {@link }
  120. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  121. * NULL_ARGUMENT}
  122. *
  123. * @access public
  124. */
  125. function updateData ( $data ) {
  126. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  127. }
  128.  
  129. /**
  130. * Get the display name for this Assessment.
  131. *
  132. * @return string
  133. *
  134. * @throws object AssessmentException An exception with one of
  135. * the following messages defined in
  136. * org.osid.assessment.AssessmentException may be thrown: {@link }
  137. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  138. * OPERATION_FAILED}, {@link }
  139. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  140. * PERMISSION_DENIED}, {@link }
  141. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  142. * CONFIGURATION_ERROR}, {@link }
  143. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  144. * UNIMPLEMENTED}
  145. *
  146. * @access public
  147. */
  148. function getDisplayName () {
  149. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  150. }
  151.  
  152. /**
  153. * Get the description for this Assessment.
  154. *
  155. * @return string
  156. *
  157. * @throws object AssessmentException An exception with one of
  158. * the following messages defined in
  159. * org.osid.assessment.AssessmentException may be thrown: {@link }
  160. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  161. * OPERATION_FAILED}, {@link }
  162. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  163. * PERMISSION_DENIED}, {@link }
  164. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  165. * CONFIGURATION_ERROR}, {@link }
  166. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  167. * UNIMPLEMENTED}
  168. *
  169. * @access public
  170. */
  171. function getDescription () {
  172. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  173. }
  174.  
  175. /**
  176. * Get the unique Id for this Assessment.
  177. *
  178. * @return object Id
  179. *
  180. * @throws object AssessmentException An exception with one of
  181. * the following messages defined in
  182. * org.osid.assessment.AssessmentException may be thrown: {@link }
  183. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  184. * OPERATION_FAILED}, {@link }
  185. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  186. * PERMISSION_DENIED}, {@link }
  187. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  188. * CONFIGURATION_ERROR}, {@link }
  189. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  190. * UNIMPLEMENTED}
  191. *
  192. * @access public
  193. */
  194. function getId () {
  195. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  196. }
  197.  
  198. /**
  199. * Get the AssessmentType for this Assessment.
  200. *
  201. * @return object Type
  202. *
  203. * @throws object AssessmentException An exception with one of
  204. * the following messages defined in
  205. * org.osid.assessment.AssessmentException may be thrown: {@link }
  206. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  207. * OPERATION_FAILED}, {@link }
  208. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  209. * PERMISSION_DENIED}, {@link }
  210. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  211. * CONFIGURATION_ERROR}, {@link }
  212. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  213. * UNIMPLEMENTED}
  214. *
  215. * @access public
  216. */
  217. function getAssessmentType () {
  218. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  219. }
  220.  
  221. /**
  222. * Get all the Property Types for Assessment.
  223. *
  224. * @return object TypeIterator
  225. *
  226. * @throws object AssessmentException An exception with one of
  227. * the following messages defined in
  228. * org.osid.assessment.AssessmentException may be thrown: {@link }
  229. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  230. * OPERATION_FAILED}, {@link }
  231. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  232. * PERMISSION_DENIED}, {@link }
  233. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  234. * CONFIGURATION_ERROR}, {@link }
  235. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  236. * UNIMPLEMENTED}
  237. *
  238. * @access public
  239. */
  240. function getPropertyTypes () {
  241. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  242. }
  243.  
  244. /**
  245. * Get the Properties associated with this Assessment.
  246. *
  247. * @return object PropertiesIterator
  248. *
  249. * @throws object AssessmentException An exception with one of
  250. * the following messages defined in
  251. * org.osid.assessment.AssessmentException may be thrown: {@link }
  252. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  253. * OPERATION_FAILED}, {@link }
  254. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  255. * PERMISSION_DENIED}, {@link }
  256. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  257. * CONFIGURATION_ERROR}, {@link }
  258. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  259. * UNIMPLEMENTED}
  260. *
  261. * @access public
  262. */
  263. function getProperties () {
  264. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  265. }
  266.  
  267. /**
  268. * Get the Topic for this Assessment.
  269. *
  270. * @return string
  271. *
  272. * @throws object AssessmentException An exception with one of
  273. * the following messages defined in
  274. * org.osid.assessment.AssessmentException may be thrown: {@link }
  275. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  276. * OPERATION_FAILED}, {@link }
  277. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  278. * PERMISSION_DENIED}, {@link }
  279. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  280. * CONFIGURATION_ERROR}, {@link }
  281. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  282. * UNIMPLEMENTED}
  283. *
  284. * @access public
  285. */
  286. function getTopic () {
  287. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  288. }
  289.  
  290. /**
  291. * Get the Data for this Assessment. The structure of the Data is not
  292. * defined in the OSID.
  293. *
  294. * @return object mixed (original type: java.io.Serializable)
  295. *
  296. * @throws object AssessmentException An exception with one of
  297. * the following messages defined in
  298. * org.osid.assessment.AssessmentException may be thrown: {@link }
  299. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  300. * OPERATION_FAILED}, {@link }
  301. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  302. * PERMISSION_DENIED}, {@link }
  303. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  304. * CONFIGURATION_ERROR}, {@link }
  305. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  306. * UNIMPLEMENTED}
  307. *
  308. * @access public
  309. */
  310. function getData () {
  311. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  312. }
  313.  
  314. /**
  315. * Get the Properties of this Type associated with this Assessment.
  316. *
  317. * @param object Type $propertiesType
  318. *
  319. * @return object Properties
  320. *
  321. * @throws object AssessmentException An exception with one of
  322. * the following messages defined in
  323. * org.osid.assessment.AssessmentException may be thrown: {@link }
  324. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  325. * OPERATION_FAILED}, {@link }
  326. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  327. * PERMISSION_DENIED}, {@link }
  328. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  329. * CONFIGURATION_ERROR}, {@link }
  330. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  331. * UNIMPLEMENTED}, {@link }
  332. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  333. * NULL_ARGUMENT}, {@link }
  334. * org.osid.assessment.AssessmentException#UNKNOWN_TYPE
  335. * UNKNOWN_TYPE}
  336. *
  337. * @access public
  338. */
  339. function getPropertiesByType ( $propertiesType ) {
  340. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  341. }
  342.  
  343. /**
  344. * Add a Section to this Assessment. The Sections added to an Assessment
  345. * are returned first in, first out (FIFO). Sections can be ordered
  346. * explicitly using the orderSections method.
  347. *
  348. * @param object Section $section
  349. *
  350. * @throws object AssessmentException An exception with one of
  351. * the following messages defined in
  352. * org.osid.assessment.AssessmentException may be thrown: {@link }
  353. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  354. * OPERATION_FAILED}, {@link }
  355. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  356. * PERMISSION_DENIED}, {@link }
  357. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  358. * CONFIGURATION_ERROR}, {@link }
  359. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  360. * UNIMPLEMENTED}, {@link }
  361. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  362. * NULL_ARGUMENT}, {@link }
  363. * org.osid.assessment.AssessmentException#ALREADY_ADDED
  364. * ALREADY_ADDED}
  365. *
  366. * @access public
  367. */
  368. function addSection ( $section ) {
  369. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  370. }
  371.  
  372. /**
  373. * Remove a Section from this Assessment.
  374. *
  375. * @param object Id $sectionId
  376. *
  377. * @throws object AssessmentException An exception with one of
  378. * the following messages defined in
  379. * org.osid.assessment.AssessmentException may be thrown: {@link }
  380. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  381. * OPERATION_FAILED}, {@link }
  382. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  383. * PERMISSION_DENIED}, {@link }
  384. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  385. * CONFIGURATION_ERROR}, {@link }
  386. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  387. * UNIMPLEMENTED}, {@link }
  388. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  389. * NULL_ARGUMENT}, {@link }
  390. * org.osid.assessment.AssessmentException#UNKNOWN_ID UNKNOWN_ID}
  391. *
  392. * @access public
  393. */
  394. function removeSection ( $sectionId ) {
  395. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  396. }
  397.  
  398. /**
  399. * Get all the Sections in the Assessment. The Sections added to a
  400. * Assessment are returned first in, first out (FIFO). Sections can be
  401. * ordered explicitly using the orderSections method. Only the Sections
  402. * directly associated with this Assessment are returned.
  403. *
  404. * @return object SectionIterator
  405. *
  406. * @throws object AssessmentException An exception with one of
  407. * the following messages defined in
  408. * org.osid.assessment.AssessmentException may be thrown: {@link }
  409. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  410. * OPERATION_FAILED}, {@link }
  411. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  412. * PERMISSION_DENIED}, {@link }
  413. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  414. * CONFIGURATION_ERROR}, {@link }
  415. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  416. * UNIMPLEMENTED}
  417. *
  418. * @access public
  419. */
  420. function getSections () {
  421. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  422. }
  423.  
  424. /**
  425. * Change the order of the Sections in the Assessment. Sections normally
  426. * are returned first in, first out (FIFO). This ordering, which has
  427. * important pedagogical implications, is changed to match the order in
  428. * the Sections array. Additional added Sections are returned first in,
  429. * first out (FIFO) after the ordered Sections.
  430. *
  431. * @param object Section[] $sections
  432. *
  433. * @throws object AssessmentException An exception with one of
  434. * the following messages defined in
  435. * org.osid.assessment.AssessmentException may be thrown: {@link }
  436. * org.osid.assessment.AssessmentException#OPERATION_FAILED
  437. * OPERATION_FAILED}, {@link }
  438. * org.osid.assessment.AssessmentException#PERMISSION_DENIED
  439. * PERMISSION_DENIED}, {@link }
  440. * org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
  441. * CONFIGURATION_ERROR}, {@link }
  442. * org.osid.assessment.AssessmentException#UNIMPLEMENTED
  443. * UNIMPLEMENTED}, {@link }
  444. * org.osid.assessment.AssessmentException#NULL_ARGUMENT
  445. * NULL_ARGUMENT}, {@link }
  446. * org.osid.assessment.AssessmentException#UNKNOWN_SECTION
  447. * UNKNOWN_SECTION}
  448. *
  449. * @access public
  450. */
  451. function orderSections ( $sections ) {
  452. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  453. }
  454. }
  455.  
  456. ?>

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