Docs For Class HarmoniCanonicalCourse

Class HarmoniCanonicalCourse

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>

version: $Id: CanonicalCourse.class.php,v 1.29 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/CanonicalCourse.class.php (line 33)

CanonicalCourse
   |
   --HarmoniCanonicalCourse

Variable Summary

mixed $_hierarchy

mixed $_id

mixed $_node

mixed $_table

Method Summary

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

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 )

void _getField (mixed $key)

object Properties _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 51)

mixed $_id (line 49)

mixed $_node (line 48)

access: private

mixed $_table (line 50)

Methods

Constructor HarmoniCanonicalCourse (line 65)

The constructor.

access: public

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

object Id $id
object Node $node

addEquivalentCourse (line 774)

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

Redefinition of:

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

addTopic (line 952)

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

Redefinition of:

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

createCanonicalCourse (line 372)

Create a new CanonicalCourse. The display name defaults to the title, but this can be changed later.

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

Redefinition of:

CanonicalCourse::createCanonicalCourse(): Create a new CanonicalCourse.

createCourseOffering (line 544)

Create a new CourseOffering. The default display name is the title of the course.

The display name defaults to the title. If the title, number or displayName are left null, they default to the values of the creating agent. Niether of these defaults are in the OSID, however.

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

Redefinition of:

CanonicalCourse::createCourseOffering(): Create a new CourseOffering.

deleteCourseOffering (line 625)

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

Redefinition of:

CanonicalCourse::deleteCourseOffering(): Delete a CourseOffering.

getCanonicalCourses (line 426)

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

Redefinition of:

CanonicalCourse::getCanonicalCourses(): Get all CanonicalCourses.

getCanonicalCoursesByType (line 479)

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

Redefinition of:

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

getCourseOfferings (line 671)

Get all CourseOfferings that belong to 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 CourseOfferingIterator getCourseOfferings ()

Redefinition of:

CanonicalCourse::getCourseOfferings(): Get all CourseOfferings.

getCourseOfferingsByType (line 720)

Get all CourseOfferings of the specified Type that belong to 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 CourseOfferingIterator getCourseOfferingsByType (mixed $offeringType, object Type $offeringType )

object Type $offeringType

Redefinition of:

CanonicalCourse::getCourseOfferingsByType(): Get all CourseOfferings of the specified Type.

getCourseType (line 337)

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

Redefinition of:

CanonicalCourse::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 1075)

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

Redefinition of:

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

getDescription (line 209)

Get the description for this CanonicalCourse. Returns null if no description exists

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:

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

getDisplayName (line 259)

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

Redefinition of:

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

getEquivalentCourses (line 904)

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

Redefinition of:

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

getId (line 311)

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

Redefinition of:

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

getNumber (line 150)

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

Redefinition of:

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

getProperties (line 1213)

Get the Properties associated with this CanonicalCourse. There is is only One type of property associated with each course 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

object PropertiesIterator getProperties ()

Redefinition of:

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

getPropertiesByType (line 1249)

Get the Properties of this Type associated with this CanonicalCourse. There is is only One type of property associated with each course 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, UNKNOWN_TYPE

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

object Type $propertiesType

Redefinition of:

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

getPropertyTypes (line 1184)

Get all the Property Types for CanonicalCourse. There is is only One type of property associated with each course 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

object TypeIterator getPropertyTypes ()

Redefinition of:

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

getStatus (line 1127)

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

Redefinition of:

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

getTitle (line 96)

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

Redefinition of:

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

getTopics (line 1033)

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

Redefinition of:

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

removeEquivalentCourse (line 832)

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.

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

Redefinition of:

CanonicalCourse::removeEquivalentCourse(): Remove a equivalent courses for this CanonicalCourse.

removeTopic (line 1003)

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

Redefinition of:

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

updateCredits (line 1102)

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

Redefinition of:

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

updateDescription (line 235)

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

Redefinition of:

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

updateDisplayName (line 285)

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

Redefinition of:

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

updateNumber (line 180)

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

Redefinition of:

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

updateStatus (line 1157)

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

Redefinition of:

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

updateTitle (line 124)

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

Redefinition of:

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

_getField (line 1330)

void _getField (mixed $key)

_getProperties (line 1269)

Get a Properties object with the information about this object.

access: private

object Properties _getProperties ()

_getType (line 1337)

void _getType (mixed $typename)

_getTypes (line 1324)

void _getTypes (mixed $typename)

_setField (line 1342)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 1318)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From CanonicalCourse

CanonicalCourse::addEquivalentCourse()
CanonicalCourse::addTopic()
CanonicalCourse::createCanonicalCourse()
CanonicalCourse::createCourseOffering()
CanonicalCourse::deleteCourseOffering()
CanonicalCourse::getCanonicalCourses()
CanonicalCourse::getCanonicalCoursesByType()
CanonicalCourse::getCourseOfferings()
CanonicalCourse::getCourseOfferingsByType()
CanonicalCourse::getCourseType()
CanonicalCourse::getCredits()
CanonicalCourse::getDescription()
CanonicalCourse::getDisplayName()
CanonicalCourse::getEquivalentCourses()
CanonicalCourse::getId()
CanonicalCourse::getNumber()
CanonicalCourse::getProperties()
CanonicalCourse::getPropertiesByType()
CanonicalCourse::getPropertyTypes()
CanonicalCourse::getStatus()
CanonicalCourse::getTitle()
CanonicalCourse::getTopics()
CanonicalCourse::removeEquivalentCourse()
CanonicalCourse::removeTopic()
CanonicalCourse::updateCredits()
CanonicalCourse::updateDescription()
CanonicalCourse::updateDisplayName()
CanonicalCourse::updateNumber()
CanonicalCourse::updateStatus()
CanonicalCourse::updateTitle()

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