Interface PositionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PositionAdminSession
public interface PositionBatchAdminSession extends PositionAdminSession

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

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

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

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

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

The delete operations delete Positions in bulk. To unmap a Position from the current Realm , the PositionRealmAssignmentSession should be used. These delete operations attempt to remove the Position itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses .