Interface KeyBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, KeyAdminSession, OsidSession, OsidSession
public interface KeyBatchAdminSession extends KeyAdminSession

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

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

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

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

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

The delete operations delete Keys in bulk. To unmap a Key from the current Agency , the KeyAgencyAssignmentSession should be used. These delete operations attempt to remove the Key itself thus removing it from all known Agency catalogs. Bulk delete operations return the results in DeleteResponses .