OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.batch.GradeSystemBatchAdminSession
Implementsosid.grading.GradeSystemAdminSession
Description

This session creates, updates, and deletes GradeSystems 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 GradeSystem, a GradeSystemForm is requested using getGradeSystemFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned GradeSystemForms 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 GradeSystemForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each GradeSystemForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetGradeSystemFormsForCreate
Description

Gets the grade system forms for creating a bunch of new grade systems.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]gradeSystemRecordTypesarray of grade system record types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradeSystemBatchFormListthe grade system forms
ErrorsNULL_ARGUMENT gradeSystemRecordTypes 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 GradeSystems. 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.GradeSystemBatchFormListgradeSystemFormsthe grade system forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT gradeSystemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemFormsForUpdate
Description

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

Parametersosid.id.IdListgradeSystemIdsthe Ids of the GradeSystem
Returnosid.grading.batch.GradeSystemBatchFormListthe grade system forms
ErrorsNOT_FOUNDa gradeSystemId is not found
NULL_ARGUMENT gradeSystemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGradeSystems
Description

Updates existing grade systems. 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.GradeSystemBatchFormListgradeSystemFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT gradeSystemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllGradeSystems
Description

Deletes all GradeSystems in this Gradebook .

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

Deletes grade systems for the given Ids.

Parametersosid.id.IdListgradeSystemIdsthe Ids of the grade systems to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradeSystemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGradeSystems
Description

Adds an Id to a GradeSystem for the purpose of creating compatibility. The primary Id of the GradeSystem 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 system Id.

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

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

Parametersosid.id.IdListgradeSystemIdsa list of grade system Ids
osid.type.Type[]gradeRecordTypesarray of grade system record types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradeBatchFormListthe grade forms
ErrorsNOT_FOUNDa gradeSystemId is not found
NULL_ARGUMENT gradeSystemIds 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.
MethodcreateGrades
Description

Creates a new set of GradeSystems. 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_ARGUMENT gradeForms 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 grade systems. 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_ARGUMENT gradeIds 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_ARGUMENT gradeForms 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 grade to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradeIds 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_ARGUMENT gradeSystemId 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, it is reassigned to the given grade Id.

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