OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.batch.GradebookBatchAdminSession
Implementsosid.grading.GradebookAdminSession
Description

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

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

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

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

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

The delete operations delete Gradebooks in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetGradebookFormsForCreate
Description

Gets the gradebook forms for creating a bunch of new gradebooks.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]gradebookRecordTypesarray of gradebook record types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradebookBatchFormListthe gradebook forms
ErrorsNULL_ARGUMENT gradebookRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateGradebooks
Description

Creates a new set of Gradebooks. 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.GradebookBatchFormListgradebookFormsthe gradebook forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT gradebookForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookFormsForUpdate
Description

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

Parametersosid.id.IdListgradebookIdsthe Ids of the Gradebook
Returnosid.grading.batch.GradebookBatchFormListthe gradebook forms
ErrorsNOT_FOUNDa gradebookId is not found
NULL_ARGUMENT gradebookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGradebooks
Description

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

Deletes all Gradebooks.

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

Deletes gradebooks for the given Ids.

Parametersosid.id.IdListgradebookIdsthe Ids of the gradebooks to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradebookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGradebooks
Description

Adds an Id to a Gradebook for the purpose of creating compatibility. The primary Id of the Gradebook is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another gradebook, it is reassigned to the given gradebook 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.