Docs For Class CourseOffering

Class CourseOffering

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>

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

Located in /harmoni/oki2/osid/coursemanagement/CourseOffering.php (line 27)

Direct descendents

Class	Description
HarmoniCourseOffering	CourseOffering is a CanonicalCourse offered in a specific Term.

Method Summary

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 )

Methods

addAsset (line 564)

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

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

object Id $assetId

Redefined in descendants as:

HarmoniCourseOffering::addAsset() : 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.

addStudent (line 706)

Add a student to the roster and assign the specified Enrollment Status 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, ALREADY_ADDED

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

object Id $agentId
object Type $enrollmentStatusType

Redefined in descendants as:

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

changeStudent (line 735)

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

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

Redefined in descendants as:

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

createCourseSection (line 456)

Create a new 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_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)

Redefined in descendants as:

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

deleteCourseSection (line 484)

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

Redefined in descendants as:

HarmoniCourseOffering::deleteCourseSection() : Delete a CourseSection.

getAssets (line 616)

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

Redefined in descendants as:

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

getCanonicalCourse (line 421)

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

Redefined in descendants as:

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

getCourseGradeType (line 301)

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

Redefined in descendants as:

HarmoniCourseOffering::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 508)

Get all CourseSections.

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

Redefined in descendants as:

HarmoniCourseOffering::getCourseSections() : Get all CourseSections that belong to this CourseOffering.

getCourseSectionsByType (line 538)

Get all CourseSections 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 CourseSectionIterator getCourseSectionsByType (mixed $sectionType, object Type $sectionType )

object Type $sectionType

Redefined in descendants as:

HarmoniCourseOffering::getCourseSectionsByType() : Get all CourseSections of the specified Type that belong to this CourseOffering.

getDescription (line 201)

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

Redefined in descendants as:

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

getDisplayName (line 225)

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

Redefined in descendants as:

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

getId (line 249)

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

Redefined in descendants as:

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

getNumber (line 177)

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

Redefined in descendants as:

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

getOfferingType (line 275)

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

Redefined in descendants as:

HarmoniCourseOffering::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 397)

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

Redefined in descendants as:

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

getPropertiesByType (line 848)

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

Redefined in descendants as:

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

getPropertyTypes (line 373)

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

Redefined in descendants as:

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

getRoster (line 787)

Get the student roster.

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

Redefined in descendants as:

HarmoniCourseOffering::getRoster() : 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.

getRosterByType (line 818)

Get the student roster. Include only students with the specified Enrollment Status 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 EnrollmentRecordIterator getRosterByType (mixed $enrollmentStatusType, object Type $enrollmentStatusType )

object Type $enrollmentStatusType

Redefined in descendants as:

HarmoniCourseOffering::getRosterByType() : 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.

getStatus (line 349)

Get 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

object Type getStatus ()

Redefined in descendants as:

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

getTerm (line 325)

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

Redefined in descendants as:

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

getTitle (line 153)

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

Redefined in descendants as:

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

removeAsset (line 592)

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

Redefined in descendants as:

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

removeStudent (line 763)

Remove a student from the roster.

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

Redefined in descendants as:

HarmoniCourseOffering::removeStudent() : Remove a student from all of the course sections of this offering.

updateCourseGradeType (line 646)

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

Redefined in descendants as:

HarmoniCourseOffering::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 103)

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

Redefined in descendants as:

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

updateDisplayName (line 129)

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

Redefined in descendants as:

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

updateNumber (line 77)

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

Redefined in descendants as:

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

updateStatus (line 674)

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

Redefined in descendants as:

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

updateTitle (line 51)

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

Redefined in descendants as:

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

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