Documentation is available at WorkEvent.php
- <?php
- /**
- * A Work Event is an output State for a Step that is associated with an Agent
- * and point in time.
- *
- * <p>
- * OSID Version: 2.0
- * </p>
- *
- * <p>
- * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
- * O.K.I. OSID Definition License}.
- * </p>
- *
- * @package org.osid.workflow
- */
- class WorkEvent
- {
- /**
- * Get when this Event happened.
- *
- * @return int
- *
- * @throws object WorkflowException An exception with one of the
- * following messages defined in
- * org.osid.workflow.WorkflowException may be thrown: {@link }
- * org.osid.workflow.WorkflowException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.workflow.WorkflowException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.workflow.WorkflowException#UNIMPLEMENTED
- * UNIMPLEMENTED}
- *
- * @access public
- */
- function getTimestamp () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Get the unique Id of the Agent that performed this Event.
- *
- * @return object Id
- *
- * @throws object WorkflowException An exception with one of the
- * following messages defined in
- * org.osid.workflow.WorkflowException may be thrown: {@link }
- * org.osid.workflow.WorkflowException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.workflow.WorkflowException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.workflow.WorkflowException#UNIMPLEMENTED
- * UNIMPLEMENTED}
- *
- * @access public
- */
- function getAgentId () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Get a Step by unique Id.
- *
- * @return object Step
- *
- * @throws object WorkflowException An exception with one of the
- * following messages defined in
- * org.osid.workflow.WorkflowException may be thrown: {@link }
- * org.osid.workflow.WorkflowException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.workflow.WorkflowException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.workflow.WorkflowException#UNIMPLEMENTED
- * UNIMPLEMENTED}
- *
- * @access public
- */
- function getStep () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Get the Output State for this Event.
- *
- * @return string
- *
- * @throws object WorkflowException An exception with one of the
- * following messages defined in
- * org.osid.workflow.WorkflowException may be thrown: {@link }
- * org.osid.workflow.WorkflowException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.workflow.WorkflowException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.workflow.WorkflowException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.workflow.WorkflowException#UNIMPLEMENTED
- * UNIMPLEMENTED}
- *
- * @access public
- */
- function getOutputState () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- }
- ?>
Documentation generated on Wed, 19 Sep 2007 10:28:13 -0400 by phpDocumentor 1.3.0RC3