Docs For Class HarmoniCourseSection

Class HarmoniCourseSection

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>

version: $Id: CourseSection.class.php,v 1.26 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/CourseSection.class.php (line 31)

CourseSection
   |
   --HarmoniCourseSection

Variable Summary

mixed $_hierarchy

mixed $_id

mixed $_node

mixed $_table

Method Summary

void HarmoniCourseSection (object Id $id, mixed $node, object Node $node )

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 )

void _getField (mixed $key)

void _getProperties ()

void _getType (mixed $typename)

void _getTypes (mixed $typename)

void _setField (mixed $key, mixed $value)

void _typeToIndex (mixed $typename, mixed $type)

Variables

mixed $_hierarchy (line 54)

mixed $_id (line 52)

mixed $_node (line 51)

access: private

mixed $_table (line 53)

Methods

Constructor HarmoniCourseSection (line 65)

The constructor.

access: public

void HarmoniCourseSection (object Id $id, mixed $node, object Node $node )

object Id $id
object Node $node

addAsset (line 562)

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.

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

Redefinition of:

CourseSection::addAsset(): Add an Asset for this CourseSection.

addStudent (line 767)

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

Redefinition of:

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

changeStudent (line 824)

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

Redefinition of:

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

getAssets (line 642)

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

Redefinition of:

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

getCourseOffering (line 527)

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

Redefinition of:

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

getDescription (line 280)

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

Redefinition of:

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

getDisplayName (line 304)

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

Redefinition of:

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

getId (line 328)

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

Redefinition of:

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

getLocation (line 424)

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

Redefinition of:

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

getNumber (line 256)

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

Redefinition of:

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

getProperties (line 501)

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

Redefinition of:

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

getPropertiesByType (line 1057)

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

Redefinition of:

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

getPropertyTypes (line 473)

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

Redefinition of:

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

getRoster (line 920)

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

Redefinition of:

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

getRosterByType (line 975)

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

Redefinition of:

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

getSchedule (line 379)

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

Redefinition of:

CourseSection::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 353)

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

Redefinition of:

CourseSection::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 449)

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

Redefinition of:

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

getTitle (line 232)

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

Redefinition of:

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

removeAsset (line 613)

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

Redefinition of:

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

removeStudent (line 884)

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

Redefinition of:

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

updateDescription (line 156)

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

Redefinition of:

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

updateDisplayName (line 182)

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

Redefinition of:

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

updateLocation (line 208)

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)

Redefinition of:

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

updateNumber (line 130)

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

Redefinition of:

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

updateSchedule (line 685)

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

Redefinition of:

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

updateStatus (line 1027)

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

Redefinition of:

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

updateTitle (line 104)

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

Redefinition of:

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

_getField (line 1141)

void _getField (mixed $key)

_getProperties (line 1072)

void _getProperties ()

_getType (line 1148)

void _getType (mixed $typename)

_getTypes (line 1135)

void _getTypes (mixed $typename)

_setField (line 1153)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 1129)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From CourseSection

CourseSection::addAsset()
CourseSection::addStudent()
CourseSection::changeStudent()
CourseSection::getAssets()
CourseSection::getCourseOffering()
CourseSection::getDescription()
CourseSection::getDisplayName()
CourseSection::getId()
CourseSection::getLocation()
CourseSection::getNumber()
CourseSection::getProperties()
CourseSection::getPropertiesByType()
CourseSection::getPropertyTypes()
CourseSection::getRoster()
CourseSection::getRosterByType()
CourseSection::getSchedule()
CourseSection::getSectionType()
CourseSection::getStatus()
CourseSection::getTitle()
CourseSection::removeAsset()
CourseSection::removeStudent()
CourseSection::updateDescription()
CourseSection::updateDisplayName()
CourseSection::updateLocation()
CourseSection::updateNumber()
CourseSection::updateSchedule()
CourseSection::updateStatus()
CourseSection::updateTitle()

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