org.osid.grading.batch

Interface GradebookColumnBatchAdminSession

All Superinterfaces:

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

public interface GradebookColumnBatchAdminSession
extends GradebookColumnAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasGradebookColumns(AliasRequestList aliasRequests) Adds an Id to a GradebookColumn for the purpose of creating compatibility.
CreateResponseList	createGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms) Creates a new set of GradebookColumns.
DeleteResponseList	deleteAllGradebookColumns() Deletes all GradebookColumns in this Gradebook .
DeleteResponseList	deleteGradebookColumns(IdList gradebookColumnIds) Deletes gradebook columns for the given Ids.
GradebookColumnBatchFormList	getGradebookColumnFormsForCreate(Type[] gradebookColumnRecordTypes) Gets the gradebook column forms for creating a bunch of new gradebook columns.
GradebookColumnBatchFormList	getGradebookColumnFormsForUpdate(IdList gradebookColumnIds) Gets the gradebook column forms for updating an existing set of gradebook columns.
UpdateResponseList	updateGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms) Updates existing gradebook columns.

Methods inherited from interface org.osid.grading.GradebookColumnAdminSession

aliasGradebookColumn, canCreateGradebookColumns, canCreateGradebookColumnWithRecordTypes, canDeleteGradebookColumns, canManageGradebookColumnAliases, canUpdateGradebookColumns, copyGradebookColumnEntries, createGradebookColumn, deleteGradebookColumn, getGradebook, getGradebookColumnFormForCreate, getGradebookColumnFormForUpdate, getGradebookId, moveGradebookColumn, sequenceGradebookColumns, updateGradebookColumn

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

getGradebookColumnFormsForCreate

GradebookColumnBatchFormList getGradebookColumnFormsForCreate(Type[] gradebookColumnRecordTypes)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

gradebookColumnRecordTypes - array of gradebook columnrecord types to be included in each create operation or an empty list if none

Returns:

the gradebook column forms

Throws:

NullArgumentException - peers or gradebookColumnRecordTypes 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.

createGradebookColumns

CreateResponseList createGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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 .

Parameters:

gradebookColumnForms - the gradebook column forms

Returns:

the create responses

Throws:

NullArgumentException - gradebookColumnForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumnFormsForUpdate

GradebookColumnBatchFormList getGradebookColumnFormsForUpdate(IdList gradebookColumnIds)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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.

Parameters:

gradebookColumnIds - the Ids of the GradebookColumn

Returns:

the gradebook column forms

Throws:

NotFoundException - a gradebookColumnId is not found

NullArgumentException - gradebookColumnIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateGradebookColumns

UpdateResponseList updateGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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 .

Parameters:

gradebookColumnForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - gradebookColumnForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllGradebookColumns

DeleteResponseList deleteAllGradebookColumns()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes all GradebookColumns in this Gradebook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteGradebookColumns

DeleteResponseList deleteGradebookColumns(IdList gradebookColumnIds)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes gradebook columns for the given Ids.

Parameters:

gradebookColumnIds - the Ids of the gradebook columns to delete

Returns:

the delete responses

Throws:

NullArgumentException - gradebookColumnIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasGradebookColumns

AliasResponseList aliasGradebookColumns(AliasRequestList aliasRequests)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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.

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.