OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.batch.GradeEntryBatchAdminSession
Implementsosid.grading.GradeEntryAdminSession
Description

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

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

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

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

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

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

MethodgetGradeEntryFormsForCreate
Description

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

Parametersosid.grading.batch.GradeEntryPeerListpeersthe relationship peers
osid.type.Type[]gradeEntryRecordTypesarray of grade entry record types to be included in each create operation or an empty list if none
Returnosid.grading.batch.GradeEntryBatchFormListthe grade entry forms
ErrorsNOT_FOUNDa gradebookColumnId or resourceId is not found
NULL_ARGUMENT peers or gradeEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateGradeEntries
Description

Creates a new set of GradeEntries. 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.GradeEntryBatchFormListgradeEntryFormsthe grade entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT gradeEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntryFormsForUpdate
Description

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

Parametersosid.id.IdListgradeEntryIdsthe Ids of the GradeEntry
Returnosid.grading.batch.GradeEntryBatchFormListthe grade entry forms
ErrorsNOT_FOUNDa gradeEntryId is not found
NULL_ARGUMENT gradeEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGradeEntries
Description

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

Deletes all GradeEntries in this Gradebook .

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

Deletes grade entries for the given Ids.

Parametersosid.id.IdListgradeEntryIdsthe Ids of the grade entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradeEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteGradeEntriesForResource
Description

Deletes grade entries for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteGradeEntriesForGradebookColumn
Description

Deletes grade entries for the given column.

Parametersosid.id.IdgradebookColumnIdthe Id of a work
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveGradeEntriesByDate
Description

Deletes grade entries expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGradeEntries
Description

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