Interface TriggerBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, TriggerAdminSession
public interface TriggerBatchAdminSession extends TriggerAdminSession

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

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

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

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

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

The delete operations delete Triggers in bulk. To unmap a Trigger from the current System , the TriggerSystemAssignmentSession should be used. These delete operations attempt to remove the Trigger itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteTriggers .