File Source for ScheduleItem.php

<?php 
 
/**
 * ScheduleItem contains a set of AgentCommitments (e.g. calendar events) as
 * well as the creator of the ScheduleItem and some date information.
 * 
 * <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.scheduling
 */
class ScheduleItem
{
    /**
     * Update the DisplayName of this ScheduleItem.
     * 
     * @param string $displayName 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#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 ScheduleItem.
     * 
     * @param string $description 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#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."); 
    } 
 
    /**
     * Update the Start for this ScheduleItem.
     * 
     * @param int $start 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateStart ( $start ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the End for this ScheduleItem.
     * 
     * @param int $end 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateEnd ( $end ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the Status Type for this ScheduleItem.
     * 
     * @param object Type $status 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.scheduling.SchedulingException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function updateStatus ( $status ) { 
        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 ScheduleItem.  The unique Id is set when the
     * ScheduleItem is created.
     *  
     * @return object Id 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#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 DisplayName of this ScheduleItem.
     *  
     * @return string 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#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."); 
    } 
 
    /**
     * Get the description of this ScheduleItem.
     *  
     * @return string 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#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 Agent that created this ScheduleItem.
     *  
     * @return object Id 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getCreator () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Start for this ScheduleItem.
     *  
     * @return int 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getStart () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the End for this ScheduleItem.
     *  
     * @return int 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getEnd () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Status Type for this ScheduleItem.
     *  
     * @return object Type 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getStatus () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Master Identifier for this ScheduleItem.  A Master Identifier is
     * a key, rule, or function that can be used to associated more than one
     * ScheduleItem together.  An example can be recurring items where each
     * recurring item has the same Master Identifier.
     *  
     * @return string 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getMasterIdentifier () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Property Types for  ScheduleItem.
     *  
     * @return object TypeIterator 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:  {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getPropertyTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Agent commitments for this ScheduleItem.
     *  
     * @return object AgentCommitmentIterator 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAgentCommitments () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Change a previously added Agent commitment for this ScheduleItem.
     * 
     * @param object Id $agentId 
     * @param object Type $agentStatus 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#UNKNOWN_ID UNKNOWN_ID},
     *          {@link org.osid.scheduling.SchedulingException#UNKNOWN_TYPE}
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function changeAgentCommitment ( $agentId, $agentStatus ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Add an Agent commitment to this ScheduleItem.
     * 
     * @param object Id $agentId 
     * @param object Type $agentStatus 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:   {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#UNKNOWN_ID UNKNOWN_ID},
     *          {@link org.osid.scheduling.SchedulingException#UNKNOWN_TYPE}
     *          UNKNOWN_TYPE}, {@link }
     *          org.osid.shared.SharedException#ALREADY_ADDED ALREADY_ADDED}
     * 
     * @access public
     */
    function addAgentCommitment ( $agentId, $agentStatus ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Properties of this Type associated with this ScheduleItem.
     * 
     * @param object Type $propertiesType 
     *  
     * @return object Properties 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:  {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.scheduling.SchedulingException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.scheduling.SchedulingException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getPropertiesByType ( $propertiesType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Properties associated with this ScheduleItem.
     *  
     * @return object PropertiesIterator 
     * 
     * @throws object SchedulingException An exception with one of
     *          the following messages defined in
     *          org.osid.scheduling.SchedulingException may be thrown:  {@link }
     *          org.osid.scheduling.SchedulingException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.scheduling.SchedulingException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.scheduling.SchedulingException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getProperties () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>
Source for file ScheduleItem.php
