Docs For Class CanonicalCourse

Class CanonicalCourse

Description

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 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/CanonicalCourse.php (line 28)

Direct descendents

Class	Description
HarmoniCanonicalCourse	CanonicalCourse contains general information about a course. This is in

Method Summary

void addEquivalentCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

void addTopic (mixed $topic, string $topic )

object CanonicalCourse createCanonicalCourse (string $title, string $number, string $description, object Type $courseType, object Type $courseStatusType, mixed $credits, float $credits )

object CourseOffering createCourseOffering (string $title, string $number, string $description, object Id $termId, object Type $offeringType, object Type $offeringStatusType, mixed $courseGradeType, object Type $courseGradeType )

void deleteCourseOffering (mixed $courseOfferingId, object Id $courseOfferingId )

object CanonicalCourseIterator getCanonicalCourses ()

object CanonicalCourseIterator getCanonicalCoursesByType (mixed $courseType, object Type $courseType )

object CourseOfferingIterator getCourseOfferings ()

object CourseOfferingIterator getCourseOfferingsByType (mixed $offeringType, object Type $offeringType )

object Type getCourseType ()

float getCredits ()

string getDescription ()

string getDisplayName ()

object CanonicalCourseIterator getEquivalentCourses ()

object Id getId ()

string getNumber ()

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object Type getStatus ()

string getTitle ()

object StringIterator getTopics ()

void removeEquivalentCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

void removeTopic (mixed $topic, string $topic )

void updateCredits (mixed $credits, float $credits )

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

addEquivalentCourse (line 638)

Add an equivalent course which are for mapping courses across

departments, schools, or institutions as well as for providing new courses that map to previous ones. This can be used for cross-listening. Note that if course A is equivalent to course B it does not necessarily follow that course B is equivalent to course A. Course A could cover a superset of the mateiral in course B.

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

void addEquivalentCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

object Id $canonicalCourseId

Redefined in descendants as:

HarmoniCanonicalCourse::addEquivalentCourse() : Add an equivalent course which are for mapping courses across

addTopic (line 718)

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

void addTopic (mixed $topic, string $topic )

string $topic

Redefined in descendants as:

HarmoniCanonicalCourse::addTopic() : Add a Topic for this CanonicalCourse.

createCanonicalCourse (line 433)

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:

HarmoniCanonicalCourse::createCanonicalCourse() : Create a new CanonicalCourse. The display name defaults to the title, but this can be changed later.

createCourseOffering (line 523)

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

string $title
string $number
string $description
object Id $termId
object Type $offeringType
object Type $offeringStatusType
object Type $courseGradeType

Redefined in descendants as:

HarmoniCanonicalCourse::createCourseOffering() : Create a new CourseOffering. The default display name is the title of the course.

deleteCourseOffering (line 551)

Delete a 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 deleteCourseOffering (mixed $courseOfferingId, object Id $courseOfferingId )

object Id $courseOfferingId

Redefined in descendants as:

HarmoniCanonicalCourse::deleteCourseOffering() : Delete a CourseOffering.

getCanonicalCourses (line 457)

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:

HarmoniCanonicalCourse::getCanonicalCourses() : Get all CanonicalCourses.

getCanonicalCoursesByType (line 487)

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 )

object Type $courseType

Redefined in descendants as:

HarmoniCanonicalCourse::getCanonicalCoursesByType() : Get all CanonicalCourses of the specified Type.

getCourseOfferings (line 575)

Get all CourseOfferings.

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

Redefined in descendants as:

HarmoniCanonicalCourse::getCourseOfferings() : Get all CourseOfferings that belong to this CanonicalCourse.

getCourseOfferingsByType (line 605)

Get all CourseOfferings 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 CourseOfferingIterator getCourseOfferingsByType (mixed $offeringType, object Type $offeringType )

object Type $offeringType

Redefined in descendants as:

HarmoniCanonicalCourse::getCourseOfferingsByType() : Get all CourseOfferings of the specified Type that belong to this CanonicalCourse.

getCourseType (line 302)

Get the Course Type for this CanonicalCourse. 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 getCourseType ()

Redefined in descendants as:

HarmoniCanonicalCourse::getCourseType() : Get the Course Type for this CanonicalCourse. This Type is meaningful to the implementation and applications and are not specified by the OSID.

getCredits (line 326)

Get the credits 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

float getCredits ()

Redefined in descendants as:

HarmoniCanonicalCourse::getCredits() : Get the credits for this CanonicalCourse.

getDescription (line 228)

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

string getDescription ()

Redefined in descendants as:

HarmoniCanonicalCourse::getDescription() : Get the description for this CanonicalCourse. Returns null if no description exists

getDisplayName (line 252)

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

string getDisplayName ()

Redefined in descendants as:

HarmoniCanonicalCourse::getDisplayName() : Get the display name for this CanonicalCourse.

getEquivalentCourses (line 690)

Get all equivalent courses 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 CanonicalCourseIterator getEquivalentCourses ()

Redefined in descendants as:

HarmoniCanonicalCourse::getEquivalentCourses() : Get all equivalent courses for this CanonicalCourse.

getId (line 276)

Get the unique Id 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 Id getId ()

Redefined in descendants as:

HarmoniCanonicalCourse::getId() : Get the unique Id for this CanonicalCourse.

getNumber (line 204)

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

string getNumber ()

Redefined in descendants as:

HarmoniCanonicalCourse::getNumber() : Get the number for this CanonicalCourse.

getProperties (line 398)

Get the Properties associated with 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 PropertiesIterator getProperties ()

Redefined in descendants as:

HarmoniCanonicalCourse::getProperties() : Get the Properties associated with this CanonicalCourse. There is is only One type of property associated with each course object.

getPropertiesByType (line 826)

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

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

Redefined in descendants as:

HarmoniCanonicalCourse::getPropertiesByType() : Get the Properties of this Type associated with this CanonicalCourse. There is is only One type of property associated with each course object.

getPropertyTypes (line 374)

Get all the Property Types for 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 TypeIterator getPropertyTypes ()

Redefined in descendants as:

HarmoniCanonicalCourse::getPropertyTypes() : Get all the Property Types for CanonicalCourse. There is is only One type of property associated with each course object.

getStatus (line 350)

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:

HarmoniCanonicalCourse::getStatus() : Get the Status for this CanonicalCourse.

getTitle (line 180)

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

string getTitle ()

Redefined in descendants as:

HarmoniCanonicalCourse::getTitle() : Get the title for this CanonicalCourse.

getTopics (line 768)

Get all Topics 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 StringIterator getTopics ()

Redefined in descendants as:

HarmoniCanonicalCourse::getTopics() : Get all Topics for this CanonicalCourse.

removeEquivalentCourse (line 666)

Remove a equivalent courses 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_ID

void removeEquivalentCourse (mixed $canonicalCourseId, object Id $canonicalCourseId )

object Id $canonicalCourseId

Redefined in descendants as:

HarmoniCanonicalCourse::removeEquivalentCourse() : Assures that the course passed in as a parameter is no longer equivalent to any other courses. It does not matter which course calls the function. In fact, it may make the most sense for courses to call the function on themselves.

removeTopic (line 744)

Remove a Topic 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

void removeTopic (mixed $topic, string $topic )

string $topic

Redefined in descendants as:

HarmoniCanonicalCourse::removeTopic() : Remove a Topic for this CanonicalCourse.

updateCredits (line 156)

Update the credits 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

void updateCredits (mixed $credits, float $credits )

float $credits

Redefined in descendants as:

HarmoniCanonicalCourse::updateCredits() : Update the credits for this CanonicalCourse.

updateDescription (line 104)

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

void updateDescription (mixed $description, string $description )

string $description

Redefined in descendants as:

HarmoniCanonicalCourse::updateDescription() : Update the description for this CanonicalCourse.

updateDisplayName (line 130)

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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniCanonicalCourse::updateDisplayName() : Update the display name for this CanonicalCourse.

updateNumber (line 78)

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

void updateNumber (mixed $number, string $number )

string $number

Redefined in descendants as:

HarmoniCanonicalCourse::updateNumber() : Update the number for this CanonicalCourse.

updateStatus (line 796)

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:

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

updateTitle (line 52)

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

void updateTitle (mixed $title, string $title )

string $title

Redefined in descendants as:

HarmoniCanonicalCourse::updateTitle() : Update the title for this CanonicalCourse.

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