Class CourseManagementManager

Description

<p> CourseManagementManager handles creating and deleting

  • CanonicalCourse,
  • CourseGradeRecord,
  • CourseGroup,
  • Term;

and gets:

  • CanonicalCourse,
  • CourseGradeRecord,
  • CourseGroup,
  • CourseOffering,
  • CourseSection,
  • Term,
  • various implementation Types.
</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/coursemanagement/CourseManagementManager.php (line 80)

OsidManager
   |
   --CourseManagementManager
Direct descendents
Class Description
HarmoniCourseManagementManager <p> CourseManagementManager handles creating and deleting
Method Summary
object CanonicalCourse createCanonicalCourse (string $title, string $number, string $description, object Type $courseType, object Type $courseStatusType, mixed $credits, float $credits )
object CourseGradeRecord createCourseGradeRecord (object Id $agentId, object Id $courseOfferingId, object Type $courseGradeType, object mixed $courseGrade)
object CourseGroup createCourseGroup (mixed $courseGroupType, object Type $courseGroupType )
object Term createTerm (object Type $termType, mixed $schedule, object ScheduleItem[] $schedule )
void deleteCanonicalCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )
void deleteCourseGradeRecord (mixed $courseGradeRecordId, object Id $courseGradeRecordId )
void deleteCourseGroup (mixed $courseGroupId, object Id $courseGroupId )
void deleteTerm (mixed $termId, object Id $termId )
object CanonicalCourse getCanonicalCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )
object CourseGradeRecordIterator getCourseGradeRecords (object Id $agentId, object Id $courseOfferingId, mixed $courseGradeType, object Type $courseGradeType )
object CourseGroup getCourseGroup (mixed $courseGroupId, object Id $courseGroupId )
object CourseGroupIterator getCourseGroups (mixed $canonicalCourseId, object Id $canonicalCourseId )
object CourseGroupIterator getCourseGroupsByType (mixed $courseGroupType, object Type $courseGroupType )
object CourseOffering getCourseOffering (mixed $courseOfferingId, object Id $courseOfferingId )
object CourseSection getCourseSection (mixed $courseSectionId, object Id $courseSectionId )
object Term getTerm (mixed $termId, object Id $termId )
object TermIterator getTermsByDate (mixed $date, int $date )
boolean supportsUpdate ()
Methods
createCanonicalCourse (line 114)

Create a new 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
object CanonicalCourse createCanonicalCourse (string $title, string $number, string $description, object Type $courseType, object Type $courseStatusType, mixed $credits, float $credits )
  • string $title
  • string $number
  • string $description
  • object Type $courseType
  • object Type $courseStatusType
  • float $credits

Redefined in descendants as:
createCourseGradeRecord (line 752)

Create a CourseGradeRecord for the specified Agent (student), CourseOffering, CourseGradeType, and CourseGrade. Note that the intent is that this is a summative grade.

  • 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, UNKNOWN_ID
object CourseGradeRecord createCourseGradeRecord (object Id $agentId, object Id $courseOfferingId, object Type $courseGradeType, object mixed $courseGrade)

Redefined in descendants as:
createCourseGroup (line 847)

Create a CourseGroup of a particular CourseGroupType. CourseGroups can be used to model prerequisites, corequisites, majors, minors, sequences, etc.

  • 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 CourseGroup createCourseGroup (mixed $courseGroupType, object Type $courseGroupType )

Redefined in descendants as:
createTerm (line 378)

Create a new Term with a specific type and Schedule. Schedules are defined in the scheduling 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
object Term createTerm (object Type $termType, mixed $schedule, object ScheduleItem[] $schedule )
  • object Type $termType
  • object ScheduleItem[] $schedule

Redefined in descendants as:
deleteCanonicalCourse (line 142)

Delete a 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_ID
void deleteCanonicalCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

Redefined in descendants as:
deleteCourseGradeRecord (line 780)

Delete the specified CourseGradeRecord by Id. courseGradeRecordId

  • 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 deleteCourseGradeRecord (mixed $courseGradeRecordId, object Id $courseGradeRecordId )

Redefined in descendants as:
deleteCourseGroup (line 875)

Delete a CourseGroup 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, NULL_ARGUMENT, UNKNOWN_ID
void deleteCourseGroup (mixed $courseGroupId, object Id $courseGroupId )

Redefined in descendants as:
deleteTerm (line 406)

Delete 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, NULL_ARGUMENT, UNKNOWN_ID
void deleteTerm (mixed $termId, object Id $termId )

Redefined in descendants as:
getCanonicalCourse (line 196)

Get a CanonicalCourse by 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, NULL_ARGUMENT, UNKNOWN_ID
object CanonicalCourse getCanonicalCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

Redefined in descendants as:
getCanonicalCourses (line 166)

Get all CanonicalCourses.

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

Redefined in descendants as:
getCanonicalCoursesByType (line 226)

Get all CanonicalCourses of the specified Type.

  • 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 CanonicalCourseIterator getCanonicalCoursesByType (mixed $courseType, object Type $courseType )

Redefined in descendants as:
getCourseGradeRecords (line 815)

Get all the CourseGradeRecords, optionally including only those for a specific Student, CourseOffering, or CourseGradeType.

  • 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, UNKNOWN_ID
object CourseGradeRecordIterator getCourseGradeRecords (object Id $agentId, object Id $courseOfferingId, mixed $courseGradeType, object Type $courseGradeType )

Redefined in descendants as:
getCourseGradeTypes (line 691)

Get all the defined CourseGrade Types. GradeTypes are defined in the grading OSID. These Types are meaningful to the implementation and applications and are not specified by the grading 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 TypeIterator getCourseGradeTypes ()

Redefined in descendants as:
getCourseGroup (line 905)

Get a CourseGroup 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, NULL_ARGUMENT, UNKNOWN_ID
object CourseGroup getCourseGroup (mixed $courseGroupId, object Id $courseGroupId )

Redefined in descendants as:
getCourseGroups (line 965)

Get all the CourseGroups that contain the specified CanoncialCourse.

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

Redefined in descendants as:
getCourseGroupsByType (line 935)

Get all the CourseGroups of a given 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_TYPE
object CourseGroupIterator getCourseGroupsByType (mixed $courseGroupType, object Type $courseGroupType )

Redefined in descendants as:
getCourseGroupTypes (line 989)

Get all the CourseGroupTypes supported by this implementation.

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

Redefined in descendants as:
getCourseOffering (line 256)

Get a CourseOffering 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, NULL_ARGUMENT, UNKNOWN_ID
object CourseOffering getCourseOffering (mixed $courseOfferingId, object Id $courseOfferingId )

Redefined in descendants as:
getCourseOfferings (line 346)

Get all the Offerings in which the specified Agent is enrolled.

  • 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
object CourseOfferingIterator getCourseOfferings (mixed $agentId, object Id $agentId )

Redefined in descendants as:
getCourseSection (line 286)

Get a CourseSection 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, NULL_ARGUMENT, UNKNOWN_ID
object CourseSection getCourseSection (mixed $courseSectionId, object Id $courseSectionId )

Redefined in descendants as:
getCourseSections (line 316)

Get all the Sections in which the specified Agent is enrolled.

  • 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
object CourseSectionIterator getCourseSections (mixed $agentId, object Id $agentId )

Redefined in descendants as:
getCourseStatusTypes (line 537)

Get all the defined Canonical Course Status Types. 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 TypeIterator getCourseStatusTypes ()

Redefined in descendants as:
getCourseTypes (line 511)

Get all the defined Course Types. 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 TypeIterator getCourseTypes ()

Redefined in descendants as:
getEnrollmentStatusTypes (line 665)

Get all the defined Enrollment Status Types. 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 TypeIterator getEnrollmentStatusTypes ()

Redefined in descendants as:
getOfferingStatusTypes (line 563)

Get all the defined Course Offering Status Types. 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 TypeIterator getOfferingStatusTypes ()

Redefined in descendants as:
getOfferingTypes (line 614)

Get all the defined Offering Types. 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 TypeIterator getOfferingTypes ()

Redefined in descendants as:
getSectionStatusTypes (line 589)

Get all the defined Course Section Status Types. 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 TypeIterator getSectionStatusTypes ()

Redefined in descendants as:
getSectionTypes (line 639)

Get all the defined Section Types. 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 TypeIterator getSectionTypes ()

Redefined in descendants as:
getTerm (line 436)

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, NULL_ARGUMENT, UNKNOWN_ID
object Term getTerm (mixed $termId, object Id $termId )

Redefined in descendants as:
getTerms (line 460)

Get all the Terms.

  • 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 TermIterator getTerms ()

Redefined in descendants as:
getTermsByDate (line 486)

Get all the Terms that contain this date.

  • 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 TermIterator getTermsByDate (mixed $date, int $date )
  • int $date

Redefined in descendants as:
getTermTypes (line 715)

Get all the TermTypes.

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

Redefined in descendants as:
supportsUpdate (line 1023)

This method indicates whether this implementation supports

CourseManagementManager methods: createCanonicalCourse, createCourseGradeRecord, createCourseGroup, createTerm, deleteCanonicalCourse, deleteCourseGradeRecord, deleteCourseGroup, deleteTerm. CanonicalCourse methods: addEquivalentCourse, addTopic, createCanonicalCourse, createCourseOffering, deleteCourseOffering. CourseGroup methods: addCourse, removeCourse, updateDisplayName. CourseOffering methods: addAsset, addStudent, createCourseSection, deleteCourseSection, removeAsset, removeStudent, updateCourseGradeType, updateDescription, updateDisplayName, updateStatus, updateTitle. CourseSection methods: addAsset, addStudent, changeStudent.

  • 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
boolean supportsUpdate ()

Redefined in descendants as:

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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