Interface CommitmentBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CommitmentAdminSession, OsidSession, OsidSession
public interface CommitmentBatchAdminSession extends CommitmentAdminSession

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

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

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

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

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

The delete operations delete Commitments in bulk. To unmap a Commitment from the current Calendar , the CommitmentCalendarAssignmentSession should be used. These delete operations attempt to remove the Commitment itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses .