OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Interfaceosid.grading.batch.GradeBatchAdminSession
Implementsosid.grading.GradeAdminSession
Used Byosid.grading.batch.GradingBatchManager
osid.grading.batch.GradingBatchProxyManager
Description

This session creates, updates, and deletes Grades in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Grade , a GradeForm is requested using getGradeFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned GradeForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a GradeForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each GradeForm corresponds to an attempted transaction.

The GradeForms returned from getGradeFormsForCreate() may be linked to the originating request through the peer Ids of the GradeForm . In the case where there may be duplicates, any GradeForm of the same peer Ids may be used for a create operation.

Once a batch of GradeForms are submitted for create, a CreateResponse is returned for each GradeForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createGrades() , errors specific to an individual GradeForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating GradeForm through the GradeForm Id .

For updates, GradeForms are requested to the Grade Id that is to be updated using getGradeFormsForUpdate() where the reference Id in the GradeForm may be used to link the request. Similarly, the GradeForm has metadata about the data that can be updated and it can perform validation before submitting the update. The GradeForm can only be used once for a successful update and cannot be reused.

Once a batch of GradeForms are submitted for update, an UpdateResponse is returned for each GradeForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateGrades() , errors specific to an individual GradeForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating GradeForm through the GradeForm Id .

The delete operations delete GradeForms in bulk. To unmap a GradeForm from the current Gradebook , the GradeGradebookAssignmentSession should be used. These delete operations attempt to remove the GradeForm itself thus removing it from all known Gradebook catalogs. Bulk delete operations return the results in DeleteResponses .

MethodgetGradeFormsForCreate
Description

Gets the grade forms for creating a bunch of new grades. A new form is retrieved for each supplied grade system.

Parametersosid.id.IdListgradeSystemIdsa list of grade system Ids
osid.type.Type[]gradeRecordTypesarray of grade record types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradeBatchFormListthe grade system forms
ErrorsNOT_FOUNDa gradeSystemId is not found
NULL_ARGUMENTgradeSystemId or gradeRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateGradeSystems
Description

Creates a new set of Grades . This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.grading.batch.GradeBatchFormListgradeFormsthe grade forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENTgradeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeFormsForUpdate
Description

Gets the grade forms for updating an existing set of grades. A new grade form should be requested for each update transaction.

Parametersosid.id.IdListgradeIdsthe Ids of the Grade
Returnosid.grading.batch.GradeBatchFormListthe grade forms
ErrorsNOT_FOUNDa gradeId is not found
NULL_ARGUMENTgradeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGrades
Description

Updates existing grades. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.grading.batch.GradeBatchFormListgradeFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENTgradeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllGrades
Description

Deletes all Grades in this Gradebook .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteGrades
Description

Deletes grade for the given Ids .

Parametersosid.id.IdListgradeIdsthe Ids of the grades to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENTgradeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteGradesForGradeSystem
Description

Deletes grade for the given grade system.

Parametersosid.id.IdgradeSystemIdthe Ids of a grade system
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENTgradeSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGrades
Description

Adds an Id to a Grade for the purpose of creating compatibility. The primary Id of the Grade is determined by the provider. The new Id is an alias to the primary Id . If the alias is a pointer to another grade system, it is reassigned to the given grade Id .

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENTaliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.