Source for file AgentCommitment.php

Documentation is available at AgentCommitment.php

  1. <?php
  2. /**
  3. * AgentCommitment joins an Agent to a Status Type. This is the Status of the
  4. * Commitment and not the Status of the Agent.
  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.scheduling
  16. */
  17. class AgentCommitment
  18. {
  19. /**
  20. * Get the agentId of the individual associated with this Commitment.
  21. *
  22. * @return object Id
  23. *
  24. * @throws object SchedulingException An exception with one of
  25. * the following messages defined in
  26. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  27. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  28. * OPERATION_FAILED}, {@link }
  29. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  30. * PERMISSION_DENIED}, {@link }
  31. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  32. * CONFIGURATION_ERROR}, {@link }
  33. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  34. * UNIMPLEMENTED}
  35. *
  36. * @access public
  37. */
  38. function getAgentId () {
  39. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  40. }
  41.  
  42. /**
  43. * Get the Status associated with this Commitment. For example, if the
  44. * commitment is a meeting, each particpant might have one of the Status
  45. * Type values "invited", "confirmed", "declined".
  46. *
  47. * @return object Type
  48. *
  49. * @throws object SchedulingException An exception with one of
  50. * the following messages defined in
  51. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  52. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  53. * OPERATION_FAILED}, {@link }
  54. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  55. * PERMISSION_DENIED}, {@link }
  56. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  57. * CONFIGURATION_ERROR}, {@link }
  58. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  59. * UNIMPLEMENTED}
  60. *
  61. * @access public
  62. */
  63. function getStatus () {
  64. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  65. }
  66. }
  67.  
  68. ?>

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