Source for file Process.php

<?php 
 
/**
 * A Process is an organized set of Steps.  There is an initial Step.  There
 * can be other Steps in the Process and they have a designated predecessor
 * Step.
 * 
 * <p>
 * OSID Version: 2.0
 * </p>
 * 
 * <p>
 * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
 * O.K.I&#46; OSID Definition License}.
 * </p>
 * 
 * @package org.osid.workflow
 */
class Process
{
    /**
     * Update the DisplayName of this Process.
     * 
     * @param string $displayName 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateDisplayName ( $displayName ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the description of this Process.
     * 
     * @param string $description 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateDescription ( $description ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Updates the state of this Process: true if this Process is enabled;
     * false otherwise.
     * 
     * @param boolean $enabled 
     * 
     * @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 updateEnabled ( $enabled ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the unique Id for this Process.  The unique Id is set when the
     * Process is created by a Process.
     *  
     * @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 getId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the description of this Process.
     *  
     * @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 getDescription () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Type of this Process.
     *  
     * @return object Type 
     * 
     * @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 getType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Returns true if this Process is enabled; false otherwise.
     *  
     * @return boolean 
     * 
     * @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 isEnabled () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the DisplayName of this Process.
     *  
     * @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 getDisplayName () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create an Inital Step for the specified role in this Process.  There
     * must be one and only one Initial Step.
     * 
     * @param string $displayName 
     * @param string $description 
     * @param object Id $roleId 
     *  
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID},
     *          {@link org.osid.workflow.WorkflowException#INVALID_NETWORK}
     *          INVALID_NETWORK}
     * 
     * @access public
     */
    function createInitialStep ( $displayName, $description, $roleId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create a Step with the specified Predecessor Step, for the specified
     * role in this Process.  A Step cannot be its own immediate predecessor,
     * but looping is permitted.
     * 
     * @param object Id $predecessorStepId 
     * @param string $displayName 
     * @param string $description 
     * @param object Id $roleId 
     *  
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID},
     *          {@link org.osid.workflow.WorkflowException#INVALID_NETWORK}
     *          INVALID_NETWORK}
     * 
     * @access public
     */
    function createStep ( $predecessorStepId, $displayName, $description, $roleId ) { 
        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.
     * 
     * @param object Id $stepId 
     *  
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getStep ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Steps in this Process.
     *  
     * @return object StepIterator 
     * 
     * @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 getSteps () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete a Step by unique Id.
     * 
     * @param object Id $stepId 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteStep ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create Work.  Work is not deleted.  When the Terminal Step is reached,
     * Work is completed.
     * 
     * @param string $displayName 
     * @param string $description 
     * @param object Id $qualifierId 
     *  
     * @return object Work 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function createWork ( $displayName, $description, $qualifierId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete Work.  Work is not deleted.  When the Terminal Step is reached,
     * Work is completed.
     * 
     * @param object Id $workId 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteWork ( $workId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get Work by unique Id.
     * 
     * @param object Id $workId 
     *  
     * @return object Work 
     * 
     * @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 getWork ( $workId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Work.
     *  
     * @return object WorkIterator 
     * 
     * @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 getAllWork () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work available to be acted on by the Owner.
     *  
     * @return object WorkIterator 
     * 
     * @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 getAvailableWork () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work available to be acted on by the Owner with this Role
     * unique Id.
     * 
     * @param object Id $roleId 
     *  
     * @return object WorkIterator 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getAvailableWorkForRole ( $roleId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work available to be acted on by the Owner for this Step.
     * 
     * @param object Id $stepId 
     *  
     * @return object WorkIterator 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getAvailableWorkForStep ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work unfinished to be acted on by anyone.
     *  
     * @return object WorkIterator 
     * 
     * @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 getUnfinishedWork () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work unfinished to be acted on by anyone with this Role
     * unique Id.
     * 
     * @param object Id $roleId 
     *  
     * @return object WorkIterator 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getUnfinishedWorkForRole ( $roleId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the work unfinished to be acted on by anyone for this Step.
     * 
     * @param object Id $stepId 
     *  
     * @return object WorkIterator 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getUnfinishedWorkForStep ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Halt the specified Work.
     * 
     * @param object Id $workId 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function haltWork ( $workId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Resume the specified halted Work.
     * 
     * @param object Id $workId 
     * 
     * @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}, {@link }
     *          org.osid.workflow.WorkflowException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.workflow.WorkflowException#UNKNOWN_ID UNKNOWN_ID},
     *          {@link org.osid.workflow.WorkflowException#NOT_HALTED}
     *          NOT_HALTED}
     * 
     * @access public
     */
    function resumeWork ( $workId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>