OSID Logo
OSID Specifications
commenting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.batch.BookBatchAdminSession
Implementsosid.commenting.BookAdminSession
Description

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

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

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

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

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

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

MethodgetBookFormsForCreate
Description

Gets the book forms for creating a bunch of new books.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]bookRecordTypesarray of book record types to be included in each create operation or an empty list if none
Returnosid.commenting.batch.BookBatchFormListthe book forms
ErrorsNULL_ARGUMENT bookRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBooks
Description

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

Parametersosid.commenting.batch.BookBatchFormListbookFormsthe book forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT bookForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBookFormsForUpdate
Description

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

Parametersosid.id.IdListbookIdsthe Ids of the Book
Returnosid.commenting.batch.BookBatchFormListthe book form
ErrorsNOT_FOUNDan bookId is not found
NULL_ARGUMENT bookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBooks
Description

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

Parametersosid.commenting.batch.BookBatchFormListbookFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT bookForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBooks
Description

Deletes all Books.

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

Deletes books for the given Ids.

Parametersosid.id.IdListbookIdsthe Ids of the books to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT bookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBooks
Description

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