Docs For Class CourseGroup

Description

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.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/coursemanagement/CourseGroup.php (line 19)

Direct descendents

Class	Description
HarmoniCourseGroup	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.

Method Summary

void addCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

object CanonicalCourseIterator getCourses ()

string getDisplayName ()

object Id getId ()

object Type getType ()

void removeCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

void updateDisplayName (mixed $displayName, string $displayName )

Methods

addCourse (line 146)

Add a CanonicalCourse to this CourseGroup. Order may be preserved, depending on CourseGroupType.

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, ALREADY_ADDED

void addCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

object Id $canonicalCourseId

Redefined in descendants as:

HarmoniCourseGroup::addCourse() : Add a CanonicalCourse to this CourseGroup. Order may be preserved, depending on CourseGroupType.

getCourses (line 201)

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.

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 CanonicalCourseIterator getCourses ()

Redefined in descendants as:

HarmoniCourseGroup::getCourses() : 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.

getDisplayName (line 67)

Get the display name for this CourseGroup.

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 ()

Redefined in descendants as:

HarmoniCourseGroup::getDisplayName() : Get the display name for this CourseGroup.

getId (line 91)

Get the unique Id for this CourseGroup.

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 ()

Redefined in descendants as:

HarmoniCourseGroup::getId() : Get the unique Id for this CourseGroup.

getType (line 115)

Get the Type for this CourseGroup.

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 getType ()

Redefined in descendants as:

HarmoniCourseGroup::getType() : Get the Type for this CourseGroup.

removeCourse (line 174)

Remove a CanonicalCourse from the CourseGroup.

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 removeCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

object Id $canonicalCourseId

Redefined in descendants as:

HarmoniCourseGroup::removeCourse() : Remove a CanonicalCourse from the CourseGroup.

updateDisplayName (line 43)

Update the display name for this CourseGroup.

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

Redefined in descendants as:

HarmoniCourseGroup::updateDisplayName() : Update the display name for this CourseGroup.