Interface PostBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PostAdminSession
public interface PostBatchAdminSession extends PostAdminSession

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

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

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

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

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

The delete operations delete Posts in bulk. To unmap a Post from the current Forum , the PostForumAssignmentSession should be used. These delete operations attempt to remove the Post itself thus removing it from all known Forum catalogs. Bulk delete operations return the results in DeleteResponses .