Interface TodoBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, TodoAdminSession
public interface TodoBatchAdminSession extends TodoAdminSession

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

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

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

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

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

The delete operations delete Todos in bulk. To unmap a Todo from the current Checklist , the TodoChecklistAssignmentSession should be used. These delete operations attempt to remove the Todo itself thus removing it from all known Checklist catalogs. Bulk delete operations return the results in DeleteResponses .