Source for file Section.php

<?php 
 
/**
 * Section includes zero or more Items and can also contain other Sections.
 * The Items added to a Section are returned first in, first out (FIFO).
 * Items can be ordered explicitly using the orderItems method.  The Sections
 * added to a Section are returned first in, first out (FIFO).  Sections can
 * be ordered explicitly using the orderSections method. SectionType is
 * meaningful to an application and not specifcally defined in the OSID. The
 * unique Id is set by the AssessmentManager's createSection method's
 * implementation.
 * 
 * <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 Section
{
    /**
     * Update the display name for this Section.
     * 
     * @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 description for this Section.
     * 
     * @param string $description 
     * 
     * @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 updateDescription ( $description ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the data for this Section.  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 Section.
     *  
     * @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 description for this Section.
     *  
     * @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 getDescription () { 
        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 Item.
     *  
     * @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 SectionType for this Section.  is meaningful to an application
     * and not specifcally defined in the OSID
     *  
     * @return object Type 
     * 
     * @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 getSectionType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Data for this Section.  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."); 
    } 
 
    /**
     * Get all the Property Types for  Section.
     *  
     * @return object TypeIterator 
     * 
     * @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 getPropertyTypes () { 
        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 Section.
     *  
     * @return object PropertiesIterator 
     * 
     * @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 getProperties () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Add an Item to this Section.  The Items added to a Section are returned
     * first in, first out (FIFO).  Items can be ordered explicitly using the
     * orderItems method.
     * 
     * @param object Item $item 
     * 
     * @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#ALREADY_ADDED
     *          ALREADY_ADDED}
     * 
     * @access public
     */
    function addItem ( $item ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Remove an Item from this Section.
     * 
     * @param object Id $itemId 
     * 
     * @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 removeItem ( $itemId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Items in this Section.  The Items added to a Section are
     * returned first in, first out (FIFO).  Items can be ordered explicitly
     * using the orderItems method. Only the Items directly associated with
     * this Section are returned.
     *  
     * @return object ItemIterator 
     * 
     * @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 getItems () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Change the order of the  Items in the Section.  Items normally are
     * returned first in, first out (FIFO).  This ordering, which has
     * important pedagogical implications, is changed to match the order in
     * the  Items array.  Additional added Items are returned first in, first
     * out (FIFO) after the ordered Items.
     * 
     * @param object Item[] $items 
     * 
     * @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 orderItems ( $items ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Add a Section to this Section. The Sections added to a Section are
     * returned first in, first out (FIFO).  Sections can be ordered
     * explicitly using the orderSections method.
     * 
     * @param object Section $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}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.assessment.AssessmentException#ALREADY_ADDED
     *          ALREADY_ADDED}
     * 
     * @access public
     */
    function addSection ( $section ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Remove a Section from this Section.
     * 
     * @param object Id $sectionId 
     * 
     * @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 removeSection ( $sectionId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Sections in this Section.  The Sections added to a Section
     * are returned first in, first out (FIFO).  Sections can be ordered
     * explicitly using the orderSections method. Only the Sections directly
     * associated with this Section are returned.
     *  
     * @return object SectionIterator 
     * 
     * @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 getSections () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Change the order of the  Sections in the Section.  Sections normally are
     * returned first in, first out (FIFO).  This ordering, which has
     * important pedagogical implications, is changed to match the order in
     * the  Sections array.  Additional added Sections are returned first in,
     * first out (FIFO) after the ordered Sections.
     * 
     * @param object Section[] $sections 
     * 
     * @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_SECTION
     *          UNKNOWN_SECTION}
     * 
     * @access public
     */
    function orderSections ( $sections ) { 
        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 Section.
     * 
     * @param object Type $propertiesType 
     *  
     * @return object Properties 
     * 
     * @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 getPropertiesByType ( $propertiesType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>