File Source for Step.php

<?php 
 
/**
 * Step is a pivotal element in a Process. Processes are made up of Steps. A
 * Step is composed of links to other Steps, and has InputConditions and
 * OutputStates.
 * 
 * <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 Step
{
    /**
     * Update the DisplayName of this Step.
     * 
     * @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 Step.
     * 
     * @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."); 
    } 
 
    /**
     * Get the unique Id for this Step.  The unique Id is set when the Step 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 Step.
     *  
     * @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 unique Id of the role associated with this Step.
     *  
     * @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 getRoleId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the DisplayName of this Step.
     *  
     * @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."); 
    } 
 
    /**
     * Update the unique Id of the role associate with this Step.
     * 
     * @param object Id $roleId 
     * 
     * @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 updateRoleId ( $roleId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Returns true if this Step is the final one in the Process; 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 isTerminal () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Returns true if this Step is the first one in the Process; 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 isInitial () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the immediate predecessor Steps for this Step.
     *  
     * @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 getPredecessors () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the immediate successor Steps for this Step from among those
     * supported by the implementation.
     *  
     * @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 getSuccessors () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the input conditions for this Step.
     *  
     * @return object ExpressionIterator 
     * 
     * @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 getInputConditions () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Define the possible input conditions for this Step.
     * 
     * @param object Expression[] $inputConditions 
     * 
     * @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_EXPRESSION
     *          UNKNOWN_EXPRESSION}
     * 
     * @access public
     */
    function updateInputConditions ( $inputConditions ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Define the possible output states for this Step from among those
     * supported by the implementation.
     * 
     * @param string $outputStates 
     * 
     * @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_OUTPUT_STATE
     *          UNKNOWN_OUTPUT_STATE}
     * 
     * @access public
     */
    function updateOutputStates ( $outputStates ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the output states for this Step.
     *  
     * @return object StringIterator 
     * 
     * @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 getOutputStates () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Add a Step as an immediate predecessor of this Step.  A Step cannot be
     * its own immediate predecessor, but looping is permitted.
     * 
     * @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},
     *          {@link org.osid.workflow.WorkflowException#INVALID_NETWORK}
     *          INVALID_NETWORK}
     * 
     * @access public
     */
    function addPredecessor ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Remove a Step that is an immediate predecessor of this Step.
     * 
     * @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},
     *          {@link org.osid.workflow.WorkflowException#INVALID_NETWORK}
     *          INVALID_NETWORK}
     * 
     * @access public
     */
    function removePredecessor ( $stepId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>
Source for file Step.php
