Class HarmoniTerm

Description
Description | Vars (details) | Methods (details)

Term includes an unique Id assigned by the implementation, a display name, a termType, and a schedule.

OSID Version: 2.0

  • version: $Id: Term.class.php,v 1.17 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/Term.class.php (line 20) 

Term
   |
   --HarmoniTerm
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_id
mixed $_table
Method Summary
Description | Vars (details) | Methods (details)
void HarmoniTerm (mixed $id, object Id $id )
string getDisplayName ()
object Id getId ()
object ScheduleItemIterator getSchedule ()
object Type getType ()
void updateDisplayName (mixed $displayName, string $displayName )
void _getField (mixed $key)
void _getType (mixed $typename)
void _getTypes (mixed $typename)
void _setField (mixed $key, mixed $value)
void _typeToIndex (mixed $typename, mixed $type)
Variables
Description | Vars (details) | Methods (details)
mixed $_id (line 30)
  • access: private
mixed $_table (line 31)
Methods
Description | Vars (details) Methods (details)
Constructor HarmoniTerm (line 41)

The constructor.

  • access: public
void HarmoniTerm (mixed $id, object Id $id )
  • object Id $id
getDisplayName (line 97)

Get the display name for this Term.

  • 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:
Term::getDisplayName()
Get the display name for this Term.
getId (line 122)

Get the unique Id for this Term.

  • 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:
Term::getId()
Get the unique Id for this Term.
getSchedule (line 175)

Get the Schedule for this Term. 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:
Term::getSchedule()
Get the Schedule for this Term. Schedules are defined in scheduling OSID. ScheduleItems are returned in chronological order by increasing start date.
getType (line 148)

Get the Type for this Term. This Type is meaningful to the implementation and applications and is 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 getType ()
Redefinition of:
Term::getType()
Get the Type for this Term. This Type is meaningful to the implementation and applications and is not specified by the OSID.
updateDisplayName (line 72)

Update the display name for this Term.

  • 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:
Term::updateDisplayName()
Update the display name for this Term.
_getField (line 223)
void _getField (mixed $key)
_getType (line 230)
void _getType (mixed $typename)
_getTypes (line 217)
void _getTypes (mixed $typename)
_setField (line 235)
void _setField (mixed $key, mixed $value)
_typeToIndex (line 211)
void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From Term

Term::getDisplayName()
Term::getId()
Term::getSchedule()
Term::getType()
Term::updateDisplayName()

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