Interface ForumBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ForumAdminSession, OsidSession, OsidSession
public interface ForumBatchAdminSession extends ForumAdminSession

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

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

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

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

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

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