Interface | osid.hold.batch.BlockBatchAdminSession | ||
---|---|---|---|
Implements | osid.hold.BlockAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getBlockFormsForCreate | ||
Description |
Gets the block forms for creating a bunch of new
blocks. A BlockForm is returned for each hold | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | blockRecordTypes | array of block record types to be included in each create operation or an empty list if none | |
Return | osid.hold.batch.BlockBatchFormList | the block forms | |
Errors | NULL_ARGUMENT | blockRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBlocks | ||
Description |
Creates a new set of | ||
Parameters | osid.hold.batch.BlockBatchFormList | blockForms | the block forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | blockForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockFormsForUpdate | ||
Description |
Gets the block forms for updating an existing set of blocks. A new block form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | blockIds | the Ids of the Block |
Return | osid.hold.batch.BlockBatchFormList | the block form | |
Errors | NOT_FOUND | a blockId is not found | |
NULL_ARGUMENT | blockIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBlocks | ||
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 | ||
Parameters | osid.hold.batch.BlockBatchFormList | blockForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | blockForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllBlocks | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteBlocks | ||
Description |
Deletes blocks for the given | ||
Parameters | osid.id.IdList | blockIds | the Ids of the blocks to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | blockIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasBlocks | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |