Source for file SectionTaken.php

<?php 
 
/**
 * SectionTaken includes all the Items taken and any Evaluations for the
 * Section.  There is also any supporting data.
 * 
 * <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.assessment
 */
class SectionTaken
{
    /**
     * Update the display name for this SectionTaken.
     * 
     * @param string $displayName 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#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."); 
    } 
 
    /**
     * Update the data for this AssessmentTaken.  The structure of the Data is
     * not defined in the OSID. .
     * 
     * @param object mixed $data (original type: java.io.Serializable)
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateData ( $data ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the display name for this SectionTaken.
     *  
     * @return string 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#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 unique Id for this SectionTaken.
     *  
     * @return object Id 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#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 Section from which this SectionTaken was created.
     *  
     * @return object Section 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getSection () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Data for this SectionTaken.  The structure of the Data is not
     * defined in the OSID.
     *  
     * @return object mixed (original type: java.io.Serializable)
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getData () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create an ItemTaken based on a SectionTaken.
     * 
     * @param object Item $item 
     *  
     * @return object ItemTaken 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#UNKNOWN_ITEM
     *          UNKNOWN_ITEM}
     * 
     * @access public
     */
    function createItemTaken ( $item ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete an ItemTaken.
     * 
     * @param object Id $itemTakenId 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteItemTaken ( $itemTakenId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Items taken for this SectionTaken.  ItemsTaken are returned
     * first in, first out (FIFO). Only the items directly associated with
     * this SectionTaken are returned.
     *  
     * @return object ItemTakenIterator 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getItemsTaken () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create an Evaluation of the specified Type for this Section.
     * 
     * @param object Type $evaluationType 
     *  
     * @return object Evaluation 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function createEvaluation ( $evaluationType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete this Evaluation from this Section.
     * 
     * @param object Id $evaluationId 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteEvaluation ( $evaluationId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Evaluations of the specified Type for this Section.
     * 
     * @param object Type $evaluationType 
     *  
     * @return object EvaluationIterator 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getEvaluationsByType ( $evaluationType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Evaluations for this Section.
     *  
     * @return object EvaluationIterator 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getEvaluations () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the AssessmentTaken to which this SectionTaken belongs.
     *  
     * @return object AssessmentTaken 
     * 
     * @throws object AssessmentException An exception with one of
     *          the following messages defined in
     *          org.osid.assessment.AssessmentException may be thrown:  {@link }
     *          org.osid.assessment.AssessmentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.assessment.AssessmentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.assessment.AssessmentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.assessment.AssessmentException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAssessmentTaken () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>