Docs For Class HarmoniCourseOffering

Class HarmoniCourseOffering

Description

CourseOffering is a CanonicalCourse offered in a specific Term.

CanonicalCourse contains general information about a course in general. The CourseSection is the third and most specific course-related object. The section includes information about the location of the class as well as the roster of students. CanonicalCourses can contain other CanonicalCourses and may be organized hierarchically, in schools, departments, for majors, and so on. For each CanonicalCourse, there are zero or more offerings and for each offering, zero or more sections. All three levels have separate data for Title, Number, Description, and Id. This information can be the same or different as implementations choose and applications require.

<p> OSID Version: 2.0 </p>

version: $Id: CourseOffering.class.php,v 1.27 2007/09/04 20:25:39 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/coursemanagement/CourseOffering.class.php (line 29)

CourseOffering
   |
   --HarmoniCourseOffering

Variable Summary

mixed $_hierarchy

mixed $_id

mixed $_node

mixed $_table

Method Summary

void HarmoniCourseOffering (object Id $id, mixed $node, object Node $node )

void addAsset (mixed $assetId, object Id $assetId )

void addStudent (object Id $agentId, mixed $enrollmentStatusType, object Type $enrollmentStatusType )

void changeStudent (object Id $agentId, mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object CourseSection createCourseSection (string $title, string $number, string $description, object Type $sectionType, object Type $sectionStatusType, object mixed $location)

void deleteCourseSection (mixed $courseSectionId, object Id $courseSectionId )

object IdIterator getAssets ()

object CanonicalCourse getCanonicalCourse ()

object Type getCourseGradeType ()

object CourseSectionIterator getCourseSections ()

object CourseSectionIterator getCourseSectionsByType (mixed $sectionType, object Type $sectionType )

string getDescription ()

string getDisplayName ()

object Id getId ()

string getNumber ()

object Type getOfferingType ()

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object EnrollmentRecordIterator getRoster ()

object EnrollmentRecordIterator getRosterByType (mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object Type getStatus ()

object Term getTerm ()

string getTitle ()

void removeAsset (mixed $assetId, object Id $assetId )

void removeStudent (mixed $agentId, object Id $agentId )

void updateCourseGradeType (mixed $courseGradeType, object Type $courseGradeType )

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateNumber (mixed $number, string $number )

void updateStatus (mixed $statusType, object Type $statusType )

void updateTitle (mixed $title, string $title )

void _getField (mixed $key)

void _getProperties ()

void _getType (mixed $typename)

void _getTypes (mixed $typename)

void _setField (mixed $key, mixed $value)

void _typeToIndex (mixed $typename, mixed $type)

Variables

mixed $_hierarchy (line 53)

mixed $_id (line 51)

mixed $_node (line 50)

access: private

mixed $_table (line 52)

Methods

Constructor HarmoniCourseOffering (line 64)

The constructor.

access: public

void HarmoniCourseOffering (object Id $id, mixed $node, object Node $node )

object Id $id
object Node $node

addAsset (line 771)

Add an Asset for this CourseOffering. Does nothing if the course has a single copy of the asset and prints a warning if there is more than one copy of that asset in one course.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, ALREADY_ADDED

void addAsset (mixed $assetId, object Id $assetId )

object Id $assetId

Redefinition of:

CourseOffering::addAsset(): Add an Asset for this CourseOffering.

addStudent (line 965)

Add a student to the roster and assign the specified Enrollment Status Type.

This method makes little sense in the context of CourseOffering and remains unimplemented. Use CourseSections addStudent() instead.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE, ALREADY_ADDED

void addStudent (object Id $agentId, mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object Id $agentId
object Type $enrollmentStatusType

Redefinition of:

CourseOffering::addStudent(): Add a student to the roster and assign the specified Enrollment Status Type.

changeStudent (line 997)

Change the Enrollment Status Type for the student on the roster.

This method makes little sense in the context of CourseOffering and remains unimplemented. Use CourseSections changeStudent() instead.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

void changeStudent (object Id $agentId, mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object Id $agentId
object Type $enrollmentStatusType

Redefinition of:

CourseOffering::changeStudent(): Change the Enrollment Status Type for the student on the roster.

createCourseSection (line 533)

Create a new CourseSection.

The display name defaults to the title. If the title, number or displayName are left null, they default to the values of the creating agent. Niether of these defaults are in the OSID, however.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object CourseSection createCourseSection (string $title, string $number, string $description, object Type $sectionType, object Type $sectionStatusType, object mixed $location)

string $title
string $number
string $description
object Type $sectionType
object Type $sectionStatusType
object mixed $location: (original type: java.io.Serializable)

Redefinition of:

CourseOffering::createCourseSection(): Create a new CourseSection.

deleteCourseSection (line 600)

Delete a CourseSection.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteCourseSection (mixed $courseSectionId, object Id $courseSectionId )

object Id $courseSectionId

Redefinition of:

CourseOffering::deleteCourseSection(): Delete a CourseSection.

getAssets (line 853)

Get the Assets associated with this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object IdIterator getAssets ()

Redefinition of:

CourseOffering::getAssets(): Get the Assets associated with this CourseOffering.

getCanonicalCourse (line 487)

Get the CanonicalCourse that contains this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object CanonicalCourse getCanonicalCourse ()

Redefinition of:

CourseOffering::getCanonicalCourse(): Get the CanonicalCourse that contains this CourseOffering.

getCourseGradeType (line 349)

Get the CourseGradeType for this Offering. GradingType is defined in the grading OSID. These Types are meaningful to the implementation and applications and are not specified by the OSID.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getCourseGradeType ()

Redefinition of:

CourseOffering::getCourseGradeType(): Get the CourseGradeType for this Offering. GradingType is defined in the grading OSID. These Types are meaningful to the implementation and applications and are not specified by the OSID.

getCourseSections (line 634)

Get all CourseSections that belong to this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object CourseSectionIterator getCourseSections ()

Redefinition of:

CourseOffering::getCourseSections(): Get all CourseSections.

getCourseSectionsByType (line 697)

Get all CourseSections of the specified Type that belong to this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object CourseSectionIterator getCourseSectionsByType (mixed $sectionType, object Type $sectionType )

object Type $sectionType

Redefinition of:

CourseOffering::getCourseSectionsByType(): Get all CourseSections of the specified Type.

getDescription (line 249)

Get the description for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

Redefinition of:

CourseOffering::getDescription(): Get the description for this CourseOffering.

getDisplayName (line 273)

Get the display name for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

Redefinition of:

CourseOffering::getDisplayName(): Get the display name for this CourseOffering.

getId (line 297)

Get the unique Id for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefinition of:

CourseOffering::getId(): Get the unique Id for this CourseOffering.

getNumber (line 225)

Get the number for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getNumber ()

Redefinition of:

CourseOffering::getNumber(): Get the number for this CourseOffering.

getOfferingType (line 323)

Get the Offering Type for this CourseOffering. This Type is meaningful to the implementation and applications and are not specified by the OSID.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getOfferingType ()

Redefinition of:

CourseOffering::getOfferingType(): Get the Offering Type for this CourseOffering. This Type is meaningful to the implementation and applications and are not specified by the OSID.

getProperties (line 461)

Get the Properties associated with this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PropertiesIterator getProperties ()

Redefinition of:

CourseOffering::getProperties(): Get the Properties associated with this CourseOffering.

getPropertiesByType (line 1301)

Get the Properties of this Type associated with this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

Redefinition of:

CourseOffering::getPropertiesByType(): Get the Properties of this Type associated with this CourseOffering.

getPropertyTypes (line 433)

Get all the Property Types for CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getPropertyTypes ()

Redefinition of:

CourseOffering::getPropertyTypes(): Get all the Property Types for CourseOffering.

getRoster (line 1055)

Get the student roster. This returns all the enrollments of all the course sections. Keep in mind that they will be ordered by the students that are in section. Each student may be enrolled in several courses.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object EnrollmentRecordIterator getRoster ()

Redefinition of:

CourseOffering::getRoster(): Get the student roster.

getRosterByType (line 1142)

Get the student roster. Include only students with the specified Enrollment Status Type. This returns all the enrollments of all the course sections. Keep in mind that they will be ordered by the students that are in section. Each student may be enrolled in several CoursesSctions.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object EnrollmentRecordIterator getRosterByType (mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object Type $enrollmentStatusType

Redefinition of:

CourseOffering::getRosterByType(): Get the student roster. Include only students with the specified Enrollment Status Type.

getStatus (line 409)

Get the Status for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getStatus ()

Redefinition of:

CourseOffering::getStatus(): Get the Status for this CanonicalCourse.

getTerm (line 374)

Get a Term by unique Id.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Term getTerm ()

Redefinition of:

CourseOffering::getTerm(): Get a Term by unique Id.

getTitle (line 201)

Get the title for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getTitle ()

Redefinition of:

CourseOffering::getTitle(): Get the title for this CourseOffering.

removeAsset (line 824)

Remove an Asset for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void removeAsset (mixed $assetId, object Id $assetId )

object Id $assetId

Redefinition of:

CourseOffering::removeAsset(): Remove an Asset for this CourseOffering.

removeStudent (line 1025)

Remove a student from all of the course sections of this offering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void removeStudent (mixed $agentId, object Id $agentId )

object Id $agentId

Redefinition of:

CourseOffering::removeStudent(): Remove a student from the roster.

updateCourseGradeType (line 900)

Update the CourseGradeType for this Offering. GradingType is defined in the grading OSID. These Types are meaningful to the implementation and applications and are not specified by the OSID.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

void updateCourseGradeType (mixed $courseGradeType, object Type $courseGradeType )

object Type $courseGradeType

Redefinition of:

CourseOffering::updateCourseGradeType(): Update the CourseGradeType for this Offering. GradingType is defined in the grading OSID. These Types are meaningful to the implementation and applications and are not specified by the OSID.

updateDescription (line 151)

Update the description for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

Redefinition of:

CourseOffering::updateDescription(): Update the description for this CourseOffering.

updateDisplayName (line 177)

Update the display name for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefinition of:

CourseOffering::updateDisplayName(): Update the display name for this CourseOffering.

updateNumber (line 125)

Update the number for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateNumber (mixed $number, string $number )

string $number

Redefinition of:

CourseOffering::updateNumber(): Update the number for this CourseOffering.

updateStatus (line 930)

Update the Status for this CanonicalCourse.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

void updateStatus (mixed $statusType, object Type $statusType )

object Type $statusType

Redefinition of:

CourseOffering::updateStatus(): Update the Status for this CanonicalCourse.

updateTitle (line 98)

Update the title for this CourseOffering.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateTitle (mixed $title, string $title )

string $title

Redefinition of:

CourseOffering::updateTitle(): Update the title for this CourseOffering.

_getField (line 1374)

void _getField (mixed $key)

_getProperties (line 1314)

void _getProperties ()

_getType (line 1381)

void _getType (mixed $typename)

_getTypes (line 1368)

void _getTypes (mixed $typename)

_setField (line 1386)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 1362)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From CourseOffering

CourseOffering::addAsset()
CourseOffering::addStudent()
CourseOffering::changeStudent()
CourseOffering::createCourseSection()
CourseOffering::deleteCourseSection()
CourseOffering::getAssets()
CourseOffering::getCanonicalCourse()
CourseOffering::getCourseGradeType()
CourseOffering::getCourseSections()
CourseOffering::getCourseSectionsByType()
CourseOffering::getDescription()
CourseOffering::getDisplayName()
CourseOffering::getId()
CourseOffering::getNumber()
CourseOffering::getOfferingType()
CourseOffering::getProperties()
CourseOffering::getPropertiesByType()
CourseOffering::getPropertyTypes()
CourseOffering::getRoster()
CourseOffering::getRosterByType()
CourseOffering::getStatus()
CourseOffering::getTerm()
CourseOffering::getTitle()
CourseOffering::removeAsset()
CourseOffering::removeStudent()
CourseOffering::updateCourseGradeType()
CourseOffering::updateDescription()
CourseOffering::updateDisplayName()
CourseOffering::updateNumber()
CourseOffering::updateStatus()
CourseOffering::updateTitle()

Documentation generated on Wed, 19 Sep 2007 10:22:19 -0400 by phpDocumentor 1.3.0RC3