Interface AgentBatchAdminSession

All Superinterfaces:
AgentAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AgentBatchAdminSession extends AgentAdminSession

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

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

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

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

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

The delete operations delete Agents in bulk. To unmap an Agent from the current Agency , the AgentAgencyAssignmentSession should be used. These delete operations attempt to remove the Agent itself thus removing it from all known Agency catalogs. Bulk delete operations return the results in DeleteResponses .