org.osid.learning.batch

Interface ObjectiveBankBatchAdminSession

All Superinterfaces:

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

public interface ObjectiveBankBatchAdminSession
extends ObjectiveBankAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasObjectiveBanks(AliasRequestList aliasRequests) Adds an Id to an ObjectiveBank for the purpose of creating compatibility.
CreateResponseList	createObjectiveBanks(ObjectiveBankBatchFormList objectiveBankForms) Creates a new set of ObjectiveBanks.
DeleteResponseList	deleteAllObjectiveBanks() Deletes all ObjectiveBanks.
DeleteResponseList	deleteObjectiveBanks(IdList objectiveBankIds) Deletes objective banks for the given Ids.
ObjectiveBankBatchFormList	getObjectiveBankFormsForCreate(long number, Type[] objectiveBankRecordTypes) Gets the objective bank forms for creating a bunch of new objective banks.
ObjectiveBankBatchFormList	getObjectiveBankFormsForUpdate(IdList objectiveBankIds) Gets the objective bank forms for updating an existing set of objective banks.
UpdateResponseList	updateObjectiveBanks(ObjectiveBankBatchFormList objectiveBankForms) Updates existing objective banks.

Methods inherited from interface org.osid.learning.ObjectiveBankAdminSession

aliasObjectiveBank, canCreateObjectiveBanks, canCreateObjectiveBankWithRecordTypes, canDeleteObjectiveBanks, canManageObjectiveBankAliases, canUpdateObjectiveBanks, createObjectiveBank, deleteObjectiveBank, getObjectiveBankFormForCreate, getObjectiveBankFormForUpdate, updateObjectiveBank

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

getObjectiveBankFormsForCreate

ObjectiveBankBatchFormList getObjectiveBankFormsForCreate(long number,
                                                        Type[] objectiveBankRecordTypes)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets the objective bank forms for creating a bunch of new objective banks.

Parameters:

number - the number of forms to retrieve

objectiveBankRecordTypes - array of objective bank record types to be included in each create operation or an empty list if none

Returns:

the objective bank forms

Throws:

NullArgumentException - objectiveBankRecordTypes 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.

createObjectiveBanks

CreateResponseList createObjectiveBanks(ObjectiveBankBatchFormList objectiveBankForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Creates a new set of ObjectiveBanks. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

objectiveBankForms - the objective bank forms

Returns:

the create responses

Throws:

NullArgumentException - objectiveBankForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObjectiveBankFormsForUpdate

ObjectiveBankBatchFormList getObjectiveBankFormsForUpdate(IdList objectiveBankIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the objective bank forms for updating an existing set of objective banks. A new objective bank form should be requested for each update transaction.

Parameters:

objectiveBankIds - the Ids of the ObjectiveBank

Returns:

the objective bank form

Throws:

NotFoundException - an objectiveBankId is not found

NullArgumentException - objectiveBankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateObjectiveBanks

UpdateResponseList updateObjectiveBanks(ObjectiveBankBatchFormList objectiveBankForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Updates existing objective banks. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

objectiveBankForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - objectiveBankForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllObjectiveBanks

DeleteResponseList deleteAllObjectiveBanks()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all ObjectiveBanks.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteObjectiveBanks

DeleteResponseList deleteObjectiveBanks(IdList objectiveBankIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes objective banks for the given Ids.

Parameters:

objectiveBankIds - the Ids of the objective banks to delete

Returns:

the delete responses

Throws:

NullArgumentException - objectiveBankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasObjectiveBanks

AliasResponseList aliasObjectiveBanks(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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