Source for file WorkEvent.php

Documentation is available at WorkEvent.php

  1. <?php
  2. /**
  3. * A Work Event is an output State for a Step that is associated with an Agent
  4. * and point in time.
  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.workflow
  16. */
  17. class WorkEvent
  18. {
  19. /**
  20. * Get when this Event happened.
  21. *
  22. * @return int
  23. *
  24. * @throws object WorkflowException An exception with one of the
  25. * following messages defined in
  26. * org.osid.workflow.WorkflowException may be thrown: {@link }
  27. * org.osid.workflow.WorkflowException#OPERATION_FAILED
  28. * OPERATION_FAILED}, {@link }
  29. * org.osid.workflow.WorkflowException#PERMISSION_DENIED
  30. * PERMISSION_DENIED}, {@link }
  31. * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
  32. * CONFIGURATION_ERROR}, {@link }
  33. * org.osid.workflow.WorkflowException#UNIMPLEMENTED
  34. * UNIMPLEMENTED}
  35. *
  36. * @access public
  37. */
  38. function getTimestamp () {
  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 unique Id of the Agent that performed this Event.
  44. *
  45. * @return object Id
  46. *
  47. * @throws object WorkflowException An exception with one of the
  48. * following messages defined in
  49. * org.osid.workflow.WorkflowException may be thrown: {@link }
  50. * org.osid.workflow.WorkflowException#OPERATION_FAILED
  51. * OPERATION_FAILED}, {@link }
  52. * org.osid.workflow.WorkflowException#PERMISSION_DENIED
  53. * PERMISSION_DENIED}, {@link }
  54. * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
  55. * CONFIGURATION_ERROR}, {@link }
  56. * org.osid.workflow.WorkflowException#UNIMPLEMENTED
  57. * UNIMPLEMENTED}
  58. *
  59. * @access public
  60. */
  61. function getAgentId () {
  62. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  63. }
  64.  
  65. /**
  66. * Get a Step by unique Id.
  67. *
  68. * @return object Step
  69. *
  70. * @throws object WorkflowException An exception with one of the
  71. * following messages defined in
  72. * org.osid.workflow.WorkflowException may be thrown: {@link }
  73. * org.osid.workflow.WorkflowException#OPERATION_FAILED
  74. * OPERATION_FAILED}, {@link }
  75. * org.osid.workflow.WorkflowException#PERMISSION_DENIED
  76. * PERMISSION_DENIED}, {@link }
  77. * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
  78. * CONFIGURATION_ERROR}, {@link }
  79. * org.osid.workflow.WorkflowException#UNIMPLEMENTED
  80. * UNIMPLEMENTED}
  81. *
  82. * @access public
  83. */
  84. function getStep () {
  85. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  86. }
  87.  
  88. /**
  89. * Get the Output State for this Event.
  90. *
  91. * @return string
  92. *
  93. * @throws object WorkflowException An exception with one of the
  94. * following messages defined in
  95. * org.osid.workflow.WorkflowException may be thrown: {@link }
  96. * org.osid.workflow.WorkflowException#OPERATION_FAILED
  97. * OPERATION_FAILED}, {@link }
  98. * org.osid.workflow.WorkflowException#PERMISSION_DENIED
  99. * PERMISSION_DENIED}, {@link }
  100. * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
  101. * CONFIGURATION_ERROR}, {@link }
  102. * org.osid.workflow.WorkflowException#UNIMPLEMENTED
  103. * UNIMPLEMENTED}
  104. *
  105. * @access public
  106. */
  107. function getOutputState () {
  108. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  109. }
  110. }
  111.  
  112. ?>

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