Interface CommentBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CommentAdminSession, OsidSession, OsidSession
public interface CommentBatchAdminSession extends CommentAdminSession

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

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

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

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

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

The delete operations delete Comments in bulk. To unmap a Comment from the current Book , the CommentBookAssignmentSession should be used. These delete operations attempt to remove the Comment itself thus removing it from all known Book catalogs. Bulk delete operations return the results in DeleteResponses .