OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.batch.GradebookColumnBatchAdminSession
Implementsosid.grading.GradebookColumnAdminSession
Description

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

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

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

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

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

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

MethodgetGradebookColumnFormsForCreate
Description

Gets the gradebook column forms for creating a bunch of new gradebook columns. A form is returned for each grade entry and resource pair.

Parametersosid.type.Type[]gradebookColumnRecordTypesarray of gradebook columnrecord types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradebookColumnBatchFormListthe gradebook column forms
ErrorsNULL_ARGUMENT peers or gradebookColumnRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateGradebookColumns
Description

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

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

Parametersosid.id.IdListgradebookColumnIdsthe Ids of the GradebookColumn
Returnosid.grading.batch.GradebookColumnBatchFormListthe gradebook column forms
ErrorsNOT_FOUNDa gradebookColumnId is not found
NULL_ARGUMENT gradebookColumnIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGradebookColumns
Description

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

Deletes all GradebookColumns in this Gradebook .

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

Deletes gradebook columns for the given Ids.

Parametersosid.id.IdListgradebookColumnIdsthe Ids of the gradebook columns to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradebookColumnIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGradebookColumns
Description

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