Docs For Class HarmoniGradingManager

Class HarmoniGradingManager

Description

GradingManager handles creating and deleting:

GradableObject,
GradeRecord

and getting:

GradableObject,
GradeRecords,
various implementation Types.

All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/core/oki2/grading/HarmoniGradingManager.class.php (line 71)

OsidManager
   |
   --GradingManager
      |
      --HarmoniGradingManager

Variable Summary

mixed $_osidContext

Method Summary

void assignConfiguration (object Properties $configuration)

void assignOsidContext (mixed $context, object OsidContext $context )

object GradableObject createGradableObject (string $displayName, string $description, object Id $courseSectionId, object Id $externalReferenceId, object Type $gradeType, object Type $scoringDefinition, object Type $gradeScale, mixed $gradeWeight, int $gradeWeight )

object GradeRecord createGradeRecord (object Id $gradableObjectId, object Id $agentId, object mixed $gradeValue, mixed $GradeRecordType, object Type $GradeRecordType )

void deleteGradableObject (mixed $gradableObjectId, object Id $gradableObjectId )

void deleteGradeRecord (object Id $gradableObjectId, object Id $agentId, [mixed $GradeRecordType = null], object Type $GradeRecordType )

object GradableObject getGradableObject (mixed $gradableObjectId, object Id $gradableObjectId )

object GradableObjectIterator getGradableObjects (object Id $courseSectionId, mixed $externalReferenceId, object Id $externalReferenceId )

object GradeRecordIterator getGradeRecords (object Id $courseSectionId, object Id $externalReferenceId, object Id $gradableObjectId, object Id $agentId, mixed $GradeRecordType, object Type $GradeRecordType )

object TypeIterator getGradeRecordTypes ()

object TypeIterator getGradeScales ()

object TypeIterator getGradeTypes ()

object OsidContext getOsidContext ()

object TypeIterator getScoringDefinitions ()

void HarmoniCourseManagementManager (ref 0)

string _getField (object Id $id, string $table, string $key)

object Type _getType (object Id $id, string $table, string $typename)

object HarmoniTypeIterator _getTypes (string $typename)

object Type _indexToType (string $index, string $typename)

void _setField (object Id $id, string $table, string $key, mixed $value)

object Type _typeToIndex (string $typename, object Type $type)

Variables

mixed $_osidContext (line 84)

access: private

Methods

assignConfiguration (line 119)

Assign the configuration of this Manager. There are no valid configuration options for this manager.

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void assignConfiguration (object Properties $configuration)

object Properties $configuration: (original type: java.util.Properties)

Redefinition of:

OsidManager::assignConfiguration(): Assign the configuration of this OsidManager.

assignOsidContext (line 148)

Assign the context of this OsidManager.

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT

void assignOsidContext (mixed $context, object OsidContext $context )

object OsidContext $context

Redefinition of:

OsidManager::assignOsidContext(): Assign the context of this OsidManager.

createGradableObject (line 192)

Create a new GradableObject which includes all the elements for grading something for a CourseSection. The type of grade and other grade characteristics are also specified.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

string $displayName
string $description
object Id $courseSectionId
object Id $externalReferenceId
object Type $gradeType
object Type $scoringDefinition
object Type $gradeScale
int $gradeWeight

Redefinition of:

GradingManager::createGradableObject(): Create a new GradableObject which includes all the elements for grading something for a CourseSection. The type of grade and other grade characteristics are also specified.

createGradeRecord (line 390)

Create a new GradeRecord for an Agent and with a Grade and

GradeRecordType. The GradeRecordType is they Type of GradeRecord not the Type of Grade contained in it. GradeRecord Types might indicate a mid-term, partial, or final grade while GradeTypes might be letter, numeric, etc. The Agent in this context is not the person who took the test nor, necessarily, the person who is grading. It is the person whose "GradeBook" this is, for example the CourseSection instructor.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, UNKNOWN_TYPE

object GradeRecord createGradeRecord (object Id $gradableObjectId, object Id $agentId, object mixed $gradeValue, mixed $GradeRecordType, object Type $GradeRecordType )

object Id $gradableObjectId
object Id $agentId
object mixed $gradeValue: (original type: java.io.Serializable)
object Type $GradeRecordType

Redefinition of:

GradingManager::createGradeRecord(): Create a new GradeRecord for an Agent and with a Grade and

deleteGradableObject (line 246)

Delete a GradableObject.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteGradableObject (mixed $gradableObjectId, object Id $gradableObjectId )

object Id $gradableObjectId

Redefinition of:

GradingManager::deleteGradableObject(): Delete a GradableObject.

deleteGradeRecord (line 443)

Delete a GradeRecord. The first two parameters are required, but the third may be left null to dignify any Type

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteGradeRecord (object Id $gradableObjectId, object Id $agentId, [mixed $GradeRecordType = null], object Type $GradeRecordType )

object Id $gradableObjectId
object Id $agentId
object Type $GradeRecordType

Redefinition of:

GradingManager::deleteGradeRecord(): Delete a GradableObject.

getGradableObject (line 288)

Get a GradableObject by unique Id.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object GradableObject getGradableObject (mixed $gradableObjectId, object Id $gradableObjectId )

object Id $gradableObjectId

Redefinition of:

GradingManager::getGradableObject(): Get a GradableObject by unique Id.

getGradableObjects (line 320)

Get all the GradableObjects, optionally including only those for a specific CourseSection or External Reference to what is being graded.

If any parameter is null, what is returned is not filtered by that parameter.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object GradableObjectIterator getGradableObjects (object Id $courseSectionId, mixed $externalReferenceId, object Id $externalReferenceId )

object Id $courseSectionId
object Id $externalReferenceId

Redefinition of:

GradingManager::getGradableObjects(): Get all the GradableObjects, optionally including only those for a specific CourseSection or External Reference to what is being graded.

getGradeRecords (line 492)

Get all the GradeRecords, optionally including only those for a specific

CourseSection, GradableObject, External Reference to what is being graded, GradeRecordType, or Agent. If any parameter is null, what is returned is not filtered by that parameter. For example, getGradeRecords(xyzCourseSectionId,null,null,null,null) returns all GradeRecords for the xyzCourseSection; and getGradeRecords(xyzCourseSectionId,null,null,myAgent,quizGradeRecordType) returns all GradeRecords for quizzes taken by myAgent in the xyzCourseSection.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, UNKNOWN_TYPE

object Id $courseSectionId
object Id $externalReferenceId
object Id $gradableObjectId
object Id $agentId
object Type $GradeRecordType

Redefinition of:

GradingManager::getGradeRecords(): Get all the GradeRecords, optionally including only those for a specific

getGradeRecordTypes (line 564)

Get all GradeRecordTypes.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getGradeRecordTypes ()

Redefinition of:

GradingManager::getGradeRecordTypes(): Get all GradeRecordTypes.

getGradeScales (line 630)

Get all GradeScales.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getGradeScales ()

Redefinition of:

GradingManager::getGradeScales(): Get all GradeScales.

getGradeTypes (line 586)

Get all GradeTypes.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getGradeTypes ()

Redefinition of:

GradingManager::getGradeTypes(): Get all GradeTypes.

getOsidContext (line 133)

Return context of this OsidManager.

access: public
throws: object OsidException

object OsidContext getOsidContext ()

Redefinition of:

OsidManager::getOsidContext(): Return context of this OsidManager.

getScoringDefinitions (line 608)

Get all ScoringDefinitions.

access: public
throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getScoringDefinitions ()

Redefinition of:

GradingManager::getScoringDefinitions(): Get all ScoringDefinitions.

HarmoniCourseManagementManager (line 93)

void HarmoniCourseManagementManager (ref 0)

ref 0: object $drId A HarmoniId referencing our DR.

_getField (line 845)

Given the object in table $table with id $id, get the field with name $key

access: private

string _getField (object Id $id, string $table, string $key)

object Id $id: The Id of the object in question
string $table: The table that our object resides in
string $key: The name of the field

_getType (line 686)

For object in table $table with id $id, get the Type with type $typename

access: private

object Type _getType (object Id $id, string $table, string $typename)

object Id $id: the Id of the object in question
string $table: the table our object resides in
string $typename: the type of Type to get

_getTypes (line 645)

Get all the Types from the table specified

access: private

object HarmoniTypeIterator _getTypes (string $typename)

string $typename: the type of Types to get

_indexToType (line 708)

For get the Type with type $typename with id $index

access: private

object Type _indexToType (string $index, string $typename)

string $index: the index of the type
string $typename: the type of Type to get

_setField (line 820)

Given the object in table $table with id $id, change the field with name $key to $value

access: private

void _setField (object Id $id, string $table, string $key, mixed $value)

object Id $id: The Id of the object in question
string $table: The table that our object resides in
string $key: The name of the field
mixed $value: The value to pass in

_typeToIndex (line 750)

Find the index for our Type of type $type in its table. If it is not there, put it into the table and return the index.

access: private

object Type _typeToIndex (string $typename, object Type $type)

string $typename: the type of Type that is passed in.
object Type $type: the Type itself

Inherited Methods

Inherited From GradingManager

GradingManager::createGradableObject()
GradingManager::createGradeRecord()
GradingManager::deleteGradableObject()
GradingManager::deleteGradeRecord()
GradingManager::getGradableObject()
GradingManager::getGradableObjects()
GradingManager::getGradeRecords()
GradingManager::getGradeRecordTypes()
GradingManager::getGradeScales()
GradingManager::getGradeTypes()
GradingManager::getScoringDefinitions()

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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