Interface AppointmentBatchAdminSession

All Superinterfaces:
AppointmentAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AppointmentBatchAdminSession extends AppointmentAdminSession

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

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

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

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

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

The delete operations delete Appointments in bulk. To unmap an Appointment from the current Realm , the AppointmentRealmAssignmentSession should be used. These delete operations attempt to remove the Appointment itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses .