Source for file CourseGroup.php

<?php 
 
/**
 * CourseGroup manages a set of CanonicalCourses.  CourseGroups have a
 * CourseGroupType which characterizes the group.  CourseGroups can be used to
 * model prerequisites, corequisites, majors, minors, sequences, etc.
 * 
 * <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.coursemanagement
 */
class CourseGroup
{
    /**
     * Update the display name for this CourseGroup.
     * 
     * @param string $displayName 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#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 display name for this CourseGroup.
     *  
     * @return string 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#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 CourseGroup.
     *  
     * @return object Id 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#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 Type for this CourseGroup.
     *  
     * @return object Type 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#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."); 
    } 
 
    /**
     * Add a CanonicalCourse to this CourseGroup.  Order may be preserved,
     * depending on CourseGroupType.
     * 
     * @param object Id $canonicalCourseId 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNKNOWN_ID
     *          UNKNOWN_ID}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#ALREADY_ADDED
     *          ALREADY_ADDED}
     * 
     * @access public
     */
    function addCourse ( $canonicalCourseId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Remove a CanonicalCourse from the CourseGroup.
     * 
     * @param object Id $canonicalCourseId 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function removeCourse ( $canonicalCourseId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the CanonicalCourses in this CourseGroup.  Note that different
     * CourseGroupType imply different ordering.  For example, if the
     * CourseGroupType indicates prerequisites order would need be guaranteed;
     * if corequisites order might not need to be guaranteed.
     *  
     * @return object CanonicalCourseIterator 
     * 
     * @throws object CourseManagementException An exception
     *          with one of the following messages defined in
     *          org.osid.coursemanagement.CourseManagementException may be
     *          thrown:  {@link }
     *          org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getCourses () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>