Docs For Class CourseSection

Class CourseSection

Description

CourseSection is associated with a CourseOffering and is has a separate roster and possibly a separate SectionType from any other Sections of the Offering. CanonicalCourse contains general information about a course.

This is in contrast to the CourseOffering which contains information about a concrete offering of this course in a specific term and with identified people and roles. 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/CourseSection.php (line 29)

Direct descendents

Class	Description
HarmoniCourseSection	CourseSection is associated with a CourseOffering and is has a separate roster and possibly a separate SectionType from any other Sections of the Offering. CanonicalCourse contains general information about a course.

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

object CourseOffering getCourseOffering ()

string getDescription ()

string getDisplayName ()

object Id getId ()

object mixed getLocation ()

string getNumber ()

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

object Type getSectionType ()

object Type getStatus ()

string getTitle ()

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

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

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateLocation (object mixed $location)

void updateNumber (mixed $number, string $number )

void updateSchedule (mixed $scheduleItems, object ScheduleItem[] $scheduleItems )

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

void updateTitle (mixed $title, string $title )

Methods

addAsset (line 474)

Add an Asset for this 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, ALREADY_ADDED

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

object Id $assetId

Redefined in descendants as:

HarmoniCourseSection::addAsset() : Add an Asset for this CourseSection. 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 585)

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:

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

changeStudent (line 614)

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:

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

getAssets (line 526)

Get the Assets associated with this 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

object IdIterator getAssets ()

Redefined in descendants as:

HarmoniCourseSection::getAssets() : Get the Assets associated with this CourseSection.

getCourseOffering (line 448)

Get the CourseOffering that contains this 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

object CourseOffering getCourseOffering ()

Redefined in descendants as:

HarmoniCourseSection::getCourseOffering() : Get the CourseOffering that contains this CourseSection.

getDescription (line 229)

Get the description for this 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

string getDescription ()

Redefined in descendants as:

HarmoniCourseSection::getDescription() : Get the description for this CourseSection.

getDisplayName (line 253)

Get the display name for this 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

string getDisplayName ()

Redefined in descendants as:

HarmoniCourseSection::getDisplayName() : Get the display name for this CourseSection.

getId (line 277)

Get the unique Id for this 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

object Id getId ()

Redefined in descendants as:

HarmoniCourseSection::getId() : Get the unique Id for this CourseSection.

getLocation (line 352)

Get the location may be a room address, a map, or any other object.

return: (original type: java.io.Serializable)
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 mixed getLocation ()

Redefined in descendants as:

HarmoniCourseSection::getLocation() : Get the location may be a room address, a map, or any other object.

getNumber (line 205)

Get the number for this 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

string getNumber ()

Redefined in descendants as:

HarmoniCourseSection::getNumber() : Get the number for this CourseSection.

getProperties (line 424)

Get the Properties associated with this 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

object PropertiesIterator getProperties ()

Redefined in descendants as:

HarmoniCourseSection::getProperties() : Get the Properties associated with this CourseSection.

getPropertiesByType (line 755)

Get the Properties of this Type associated with this 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 Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

Redefined in descendants as:

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

getPropertyTypes (line 400)

Get all the Property Types for 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

object TypeIterator getPropertyTypes ()

Redefined in descendants as:

HarmoniCourseSection::getPropertyTypes() : Get all the Property Types for CourseSection.

getRoster (line 666)

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:

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

getRosterByType (line 697)

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:

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

getSchedule (line 328)

Get the Schedule for this Section. Schedules are defined in scheduling OSID. ScheduleItems are returned in chronological order by increasing start 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 ScheduleItemIterator getSchedule ()

Redefined in descendants as:

HarmoniCourseSection::getSchedule() : Get the Schedule for this Section. Schedules are defined in scheduling OSID. ScheduleItems are returned in chronological order by increasing start date.

getSectionType (line 302)

Get the Section Type for this CourseSection. 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 getSectionType ()

Redefined in descendants as:

HarmoniCourseSection::getSectionType() : Get the Section Type for this CourseSection. This Type is meaningful to the implementation and applications and are not specified by the OSID.

getStatus (line 376)

Get the Status for this 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

object Type getStatus ()

Redefined in descendants as:

HarmoniCourseSection::getStatus() : Get the Status for this CourseSection.

getTitle (line 181)

Get the title for this 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

string getTitle ()

Redefined in descendants as:

HarmoniCourseSection::getTitle() : Get the title for this CourseSection.

removeAsset (line 502)

Remove an Asset for this 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 removeAsset (mixed $assetId, object Id $assetId )

object Id $assetId

Redefined in descendants as:

HarmoniCourseSection::removeAsset() : Remove an Asset for this CourseSection.

removeStudent (line 642)

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:

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

updateDescription (line 105)

Update the description for this 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

void updateDescription (mixed $description, string $description )

string $description

Redefined in descendants as:

HarmoniCourseSection::updateDescription() : Update the description for this CourseSection.

updateDisplayName (line 131)

Update the display name for this 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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniCourseSection::updateDisplayName() : Update the display name for this CourseSection.

updateLocation (line 157)

Update the location may be a room address, a map, or any other object.

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 updateLocation (object mixed $location)

object mixed $location: (original type: java.io.Serializable)

Redefined in descendants as:

HarmoniCourseSection::updateLocation() : Update the location may be a room address, a map, or any other object.

updateNumber (line 79)

Update the number for this 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

void updateNumber (mixed $number, string $number )

string $number

Redefined in descendants as:

HarmoniCourseSection::updateNumber() : Update the number for this CourseSection.

updateSchedule (line 553)

Update the Schedule for this Section. Schedules are defined in 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

void updateSchedule (mixed $scheduleItems, object ScheduleItem[] $scheduleItems )

object ScheduleItem[] $scheduleItems

Redefined in descendants as:

HarmoniCourseSection::updateSchedule() : Update the Schedule for this Section. Schedules are defined in scheduling OSID.

updateStatus (line 725)

Update the Status for this 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

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

object Type $statusType

Redefined in descendants as:

HarmoniCourseSection::updateStatus() : Update the Status for this CourseSection.

updateTitle (line 53)

Update the title for this 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

void updateTitle (mixed $title, string $title )

string $title

Redefined in descendants as:

HarmoniCourseSection::updateTitle() : Update the title for this CourseSection.

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