Interface SignalBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SignalAdminSession
public interface SignalBatchAdminSession extends SignalAdminSession

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

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

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

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

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

The delete operations delete Signals in bulk. To unmap a Signal from the current Map , the SignalMapAssignmentSession should be used. These delete operations attempt to remove the Signal itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses .