OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.BlockBatchAdminSession
Implementsosid.hold.BlockAdminSession
Description

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.

MethodgetBlockFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]blockRecordTypesarray of block record types to be included in each create operation or an empty list if none
Returnosid.hold.batch.BlockBatchFormListthe block forms
ErrorsNULL_ARGUMENT blockRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBlocks
Description

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 .

Parametersosid.hold.batch.BlockBatchFormListblockFormsthe block forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT blockForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlockFormsForUpdate
Description

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

Parametersosid.id.IdListblockIdsthe Ids of the Block
Returnosid.hold.batch.BlockBatchFormListthe block form
ErrorsNOT_FOUNDa blockId is not found
NULL_ARGUMENT blockIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBlocks
Description

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 .

Parametersosid.hold.batch.BlockBatchFormListblockFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT blockForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBlocks
Description

Deletes all Blocks in this Oubliette .

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

Deletes blocks for the given Ids.

Parametersosid.id.IdListblockIdsthe Ids of the blocks to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT blockIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBlocks
Description

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.

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.