Class HarmoniCourseGroup

Description
Description | Vars (details) | Methods (details)

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

  • version: $Id: CourseGroup.class.php,v 1.9 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/CourseGroup.class.php (line 21) 

CourseGroup
   |
   --HarmoniCourseGroup
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_node
Method Summary
Description | Vars (details) | Methods (details)
void HarmoniCourseGroup (mixed $node, object Node $id)
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 )
Variables
Description | Vars (details) | Methods (details)
mixed $_node (line 30)
  • access: private
Methods
Description | Vars (details) Methods (details)
Constructor HarmoniCourseGroup (line 38)

The constructor.

  • access: private
void HarmoniCourseGroup (mixed $node, object Node $id)
  • object Node $id
addCourse (line 169)

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
Redefinition of:
CourseGroup::addCourse()
Add a CanonicalCourse to this CourseGroup. Order may be preserved, depending on CourseGroupType.
getCourses (line 228)

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 ()
Redefinition of:
CourseGroup::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 90)

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 ()
Redefinition of:
CourseGroup::getDisplayName()
Get the display name for this CourseGroup.
getId (line 114)

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 ()
Redefinition of:
CourseGroup::getId()
Get the unique Id for this CourseGroup.
getType (line 138)

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 ()
Redefinition of:
CourseGroup::getType()
Get the Type for this CourseGroup.
removeCourse (line 199)

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
Redefinition of:
CourseGroup::removeCourse()
Remove a CanonicalCourse from the CourseGroup.
updateDisplayName (line 66)

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
Redefinition of:
CourseGroup::updateDisplayName()
Update the display name for this CourseGroup.

Inherited Methods

Inherited From CourseGroup

CourseGroup::addCourse()
CourseGroup::getCourses()
CourseGroup::getDisplayName()
CourseGroup::getId()
CourseGroup::getType()
CourseGroup::removeCourse()
CourseGroup::updateDisplayName()

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