Interface AvailabilityBatchAdminSession

All Superinterfaces:
AutoCloseable, AvailabilityAdminSession, Closeable, OsidSession, OsidSession
public interface AvailabilityBatchAdminSession extends AvailabilityAdminSession

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

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

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

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

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

The delete operations delete Availabilities in bulk. To unmap an Availability from the current Foundry , the AvailabilityFoundryAssignmentSession should be used. These delete operations attempt to remove the Availability itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses .