org.osid.commenting.batch

Interface BookBatchAdminSession

All Superinterfaces:

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

public interface BookBatchAdminSession
extends BookAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBooks(AliasRequestList aliasRequests) Adds an Id to an Book for the purpose of creating compatibility.
CreateResponseList	createBooks(BookBatchFormList bookForms) Creates a new set of Books.
DeleteResponseList	deleteAllBooks() Deletes all Books.
DeleteResponseList	deleteBooks(IdList bookIds) Deletes books for the given Ids.
BookBatchFormList	getBookFormsForCreate(long number, Type[] bookRecordTypes) Gets the book forms for creating a bunch of new books.
BookBatchFormList	getBookFormsForUpdate(IdList bookIds) Gets the book forms for updating an existing set of books.
UpdateResponseList	updateBooks(BookBatchFormList bookForms) Updates existing books.

Methods inherited from interface org.osid.commenting.BookAdminSession

aliasBook, canCreateBooks, canCreateBookWithRecordTypes, canDeleteBooks, canManageBookAliases, canUpdateBooks, createBook, deleteBook, getBookFormForCreate, getBookFormForUpdate, updateBook

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

getBookFormsForCreate

BookBatchFormList getBookFormsForCreate(long number,
                                      Type[] bookRecordTypes)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the book forms

Throws:

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

createBooks

CreateResponseList createBooks(BookBatchFormList bookForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

bookForms - the book forms

Returns:

the create responses

Throws:

NullArgumentException - bookForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBookFormsForUpdate

BookBatchFormList getBookFormsForUpdate(IdList bookIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

bookIds - the Ids of the Book

Returns:

the book form

Throws:

NotFoundException - an bookId is not found

NullArgumentException - bookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBooks

UpdateResponseList updateBooks(BookBatchFormList bookForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

bookForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - bookForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBooks

DeleteResponseList deleteAllBooks()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Books.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBooks

DeleteResponseList deleteBooks(IdList bookIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes books for the given Ids.

Parameters:

bookIds - the Ids of the books to delete

Returns:

the delete responses

Throws:

NullArgumentException - bookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBooks

AliasResponseList aliasBooks(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

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.