Interface ActionGroupBatchAdminSession

All Superinterfaces:
ActionGroupAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface ActionGroupBatchAdminSession extends ActionGroupAdminSession

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

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

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

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

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

The delete operations delete ActionGroups in bulk. To unmap an ActionGroup from the current System , the ActionGroupSystemAssignmentSession should be used. These delete operations attempt to remove the ActionGroup itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteActionGroups .