File Source for AssessmentPublished.php

<?php 
 
/**
 * AssessmentPublished includes an Assessment as well as additional data
 * relating to the availability of the Assessment.
 * 
 * <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 AssessmentPublished
{
    /**
     * Update the display name for this AssessmentPublished.
     * 
     * @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 AssessmentPublished.
     * 
     * @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."); 
    } 
 
    /**
     * Set the unique Id of the Assignment associated with this
     * AssessmentPublished, if any.  The unique Id refers to an object created
     * through the Grading OSID.
     * 
     * @param object Id $gradingAssignmentId 
     * 
     * @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 updateGradingAssignmentId ( $gradingAssignmentId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Set the unique Id of the Course Section associated with this
     * AssessmentPublished, if any.  The unique Id refers to an object created
     * through the CourseManagement OSID.
     * 
     * @param object Id $courseSectionId 
     * 
     * @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 updateCourseSectionId ( $courseSectionId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the data for this AssessmentPublished. 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 AssessmentPublished.
     *  
     * @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 AssessmentPublished.
     *  
     * @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 AssessmentPublished.
     *  
     * @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 date the Assessment was published.
     *  
     * @return int 
     * 
     * @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 getDate () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Assessment being published.
     *  
     * @return object Assessment 
     * 
     * @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 getAssessment () { 
        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 Assignment associated with this
     * AssessmentPublished, if any.  The unique Id refers to an object created
     * through the Grading OSID.
     *  
     * @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 getGradingAssignmentId () { 
        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 Course Section associated with this
     * AssessmentPublished, if any.  The unique Id refers to an object created
     * through the CourseManagement OSID.
     *  
     * @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 getCourseSectionId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Data for this AssessmentPublished. 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 AssessmentTaken based on an AssessmentPublished and agentId of
     * the student.
     * 
     * @param object Id $agentId 
     *  
     * @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}, {@link }
     *          org.osid.assessment.AssessmentException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function createAssessmentTaken ( $agentId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete an AssessmentTaken.
     * 
     * @param object Id $assessmentTakenId 
     * 
     * @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 deleteAssessmentTaken ( $assessmentTakenId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Assessments taken.
     *  
     * @return object AssessmentTakenIterator 
     * 
     * @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 getAssessmentsTaken () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Assessments taken by a specific a student with this agentId.
     * 
     * @param object Id $agentId 
     *  
     * @return object AssessmentTakenIterator 
     * 
     * @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 getAssessmentsTakenBy ( $agentId ) { 
        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 Item.
     *  
     * @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 Evaluations of the specified Type for this Assessment.
     * 
     * @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."); 
    } 
}
 
?>
Source for file AssessmentPublished.php
