Interface EffortBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, EffortAdminSession, OsidSession, OsidSession
public interface EffortBatchAdminSession extends EffortAdminSession

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

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

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

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

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

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