org.osid.grading.batch

Interface GradeSystemBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, GradeSystemAdminSession, OsidSession

public interface GradeSystemBatchAdminSession
extends GradeSystemAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasGrades(AliasRequestList aliasRequests) Adds an Id to a Grade for the purpose of creating compatibility.
AliasResponseList	aliasGradeSystems(AliasRequestList aliasRequests) Adds an Id to a GradeSystem for the purpose of creating compatibility.
CreateResponseList	createGrades(GradeBatchFormList gradeForms) Creates a new set of GradeSystems.
CreateResponseList	createGradeSystems(GradeSystemBatchFormList gradeSystemForms) Creates a new set of GradeSystems.
DeleteResponseList	deleteAllGrades() Deletes all Grades in this Gradebook .
DeleteResponseList	deleteAllGradeSystems() Deletes all GradeSystems in this Gradebook .
DeleteResponseList	deleteGrades(IdList gradeIds) Deletes grade for the given Ids.
DeleteResponseList	deleteGradesForGradeSystem(Id gradeSystemId) Deletes grade for the given grade system.
DeleteResponseList	deleteGradeSystems(IdList gradeSystemIds) Deletes grade systems for the given Ids.
GradeBatchFormList	getGradeFormsForCreate(IdList gradeSystemIds, Type[] gradeRecordTypes) Gets the grade forms for creating a bunch of new grades.
GradeBatchFormList	getGradeFormsForUpdate(IdList gradeIds) Gets the grade forms for updating an existing set of grade systems.
GradeSystemBatchFormList	getGradeSystemFormsForCreate(long number, Type[] gradeSystemRecordTypes) Gets the grade system forms for creating a bunch of new grade systems.
GradeSystemBatchFormList	getGradeSystemFormsForUpdate(IdList gradeSystemIds) Gets the grade system forms for updating an existing set of grade systems.
UpdateResponseList	updateGrades(GradeBatchFormList gradeForms) Updates existing grades.
UpdateResponseList	updateGradeSystems(GradeSystemBatchFormList gradeSystemForms) Updates existing grade systems.

Methods inherited from interface org.osid.grading.GradeSystemAdminSession

aliasGrade, aliasGradeSystem, canCreateGrades, canCreateGradeSystems, canCreateGradeSystemWithRecordTypes, canCreateGradeWithRecordTypes, canDeleteGrades, canDeleteGradeSystems, canManageGradeAliases, canManageGradeSystemAliases, canUpdateGrades, canUpdateGradeSystems, createGrade, createGradeSystem, deleteGrade, deleteGradeSystem, getGradebook, getGradebookId, getGradeFormForCreate, getGradeFormForUpdate, getGradeSystemFormForCreate, getGradeSystemFormForUpdate, updateGrade, updateGradeSystem

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getGradeSystemFormsForCreate

GradeSystemBatchFormList getGradeSystemFormsForCreate(long number,
                                                    Type[] gradeSystemRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

gradeSystemRecordTypes - array of grade system record types to be included in each create operation or an empty list if none

Returns:

the grade system forms

Throws:

NullArgumentException - gradeSystemRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createGradeSystems

CreateResponseList createGradeSystems(GradeSystemBatchFormList gradeSystemForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

gradeSystemForms - the grade system forms

Returns:

the create responses

Throws:

NullArgumentException - gradeSystemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeSystemFormsForUpdate

GradeSystemBatchFormList getGradeSystemFormsForUpdate(IdList gradeSystemIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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.

Parameters:

gradeSystemIds - the Ids of the GradeSystem

Returns:

the grade system forms

Throws:

NotFoundException - a gradeSystemId is not found

NullArgumentException - gradeSystemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateGradeSystems

UpdateResponseList updateGradeSystems(GradeSystemBatchFormList gradeSystemForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

gradeSystemForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - gradeSystemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllGradeSystems

DeleteResponseList deleteAllGradeSystems()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all GradeSystems in this Gradebook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteGradeSystems

DeleteResponseList deleteGradeSystems(IdList gradeSystemIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes grade systems for the given Ids.

Parameters:

gradeSystemIds - the Ids of the grade systems to delete

Returns:

the delete responses

Throws:

NullArgumentException - gradeSystemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasGradeSystems

AliasResponseList aliasGradeSystems(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeFormsForCreate

GradeBatchFormList getGradeFormsForCreate(IdList gradeSystemIds,
                                        Type[] gradeRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

gradeSystemIds - a list of grade system Ids

gradeRecordTypes - array of grade system record types to be included in each create operation or an empty list if none

Returns:

the grade forms

Throws:

NotFoundException - a gradeSystemId is not found

NullArgumentException - gradeSystemIds or gradeRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createGrades

CreateResponseList createGrades(GradeBatchFormList gradeForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

gradeForms - the grade forms

Returns:

the create responses

Throws:

NullArgumentException - gradeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeFormsForUpdate

GradeBatchFormList getGradeFormsForUpdate(IdList gradeIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

gradeIds - the Ids of the Grade

Returns:

the grade forms

Throws:

NotFoundException - a gradeId is not found

NullArgumentException - gradeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateGrades

UpdateResponseList updateGrades(GradeBatchFormList gradeForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

gradeForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - gradeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllGrades

DeleteResponseList deleteAllGrades()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Grades in this Gradebook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteGrades

DeleteResponseList deleteGrades(IdList gradeIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes grade for the given Ids.

Parameters:

gradeIds - the Ids of the grade to delete

Returns:

the delete responses

Throws:

NullArgumentException - gradeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteGradesForGradeSystem

DeleteResponseList deleteGradesForGradeSystem(Id gradeSystemId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes grade for the given grade system.

Parameters:

gradeSystemId - the Ids of a grade system

Returns:

the delete responses

Throws:

NullArgumentException - gradeSystemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasGrades

AliasResponseList aliasGrades(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.