Interface LeaseBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, LeaseAdminSession, OsidSession, OsidSession
public interface LeaseBatchAdminSession extends LeaseAdminSession

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

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

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

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

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

The delete operations delete Leases in bulk. To unmap a Lease from the current Campus , the LeaseCampusAssignmentSession should be used. These delete operations attempt to remove the Lease itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses .