Interface PostEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PostEntryAdminSession
public interface PostEntryBatchAdminSession extends PostEntryAdminSession

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

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

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

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

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

The delete operations delete PostEntries in bulk. To unmap a PostEntry from the current Business , the PostEntryBusinessAssignmentSession should be used. These delete operations attempt to remove the PostEntry itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses .