org.osid.hold.batch

Interface BlockBatchAdminSession

All Superinterfaces:

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

public interface BlockBatchAdminSession
extends BlockAdminSession

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

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

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

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

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

The delete operations delete Blocks in bulk. To unmap a Block from the current Oubliette, the BlockOublietteAssignmentSession should be used. These delete operations attempt to remove the Block itself thus removing it from all known Oubliette catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBlocks(AliasRequestList aliasRequests) Adds an Id to a Block for the purpose of creating compatibility.
CreateResponseList	createBlocks(BlockBatchFormList blockForms) Creates a new set of Blocks.
DeleteResponseList	deleteAllBlocks() Deletes all Blocks in this Oubliette .
DeleteResponseList	deleteBlocks(IdList blockIds) Deletes blocks for the given Ids.
BlockBatchFormList	getBlockFormsForCreate(long number, Type[] blockRecordTypes) Gets the block forms for creating a bunch of new blocks.
BlockBatchFormList	getBlockFormsForUpdate(IdList blockIds) Gets the block forms for updating an existing set of blocks.
UpdateResponseList	updateBlocks(BlockBatchFormList blockForms) Updates existing blocks.

Methods inherited from interface org.osid.hold.BlockAdminSession

aliasBlock, canCreateBlocks, canCreateBlockWithRecordTypes, canDeleteBlocks, canManageBlockAliases, canUpdateBlocks, createBlock, deleteBlock, getBlockFormForCreate, getBlockFormForUpdate, getOubliette, getOublietteId, updateBlock

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

getBlockFormsForCreate

BlockBatchFormList getBlockFormsForCreate(long number,
                                        Type[] blockRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the block forms for creating a bunch of new blocks. A BlockForm is returned for each hold Id.

Parameters:

number - the number of forms to retrieve

blockRecordTypes - array of block record types to be included in each create operation or an empty list if none

Returns:

the block forms

Throws:

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

createBlocks

CreateResponseList createBlocks(BlockBatchFormList blockForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

blockForms - the block forms

Returns:

the create responses

Throws:

NullArgumentException - blockForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlockFormsForUpdate

BlockBatchFormList getBlockFormsForUpdate(IdList blockIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

blockIds - the Ids of the Block

Returns:

the block form

Throws:

NotFoundException - a blockId is not found

NullArgumentException - blockIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBlocks

UpdateResponseList updateBlocks(BlockBatchFormList blockForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

blockForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - blockForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBlocks

DeleteResponseList deleteAllBlocks()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Blocks in this Oubliette .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBlocks

DeleteResponseList deleteBlocks(IdList blockIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes blocks for the given Ids.

Parameters:

blockIds - the Ids of the blocks to delete

Returns:

the delete responses

Throws:

NullArgumentException - blockIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBlocks

AliasResponseList aliasBlocks(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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