org.osid.authentication.batch

Interface AgentBatchAdminSession

All Superinterfaces:

AgentAdminSession, java.lang.AutoCloseable, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAgents(AliasRequestList aliasRequests) Adds an Id to an Agent for the purpose of creating compatibility.
CreateResponseList	createAgents(AgentBatchFormList agentForms) Creates a new set of Agents.
DeleteResponseList	deleteAgents(IdList agentIds) Deletes agents for the given Ids.
DeleteResponseList	deleteAllAgents() Deletes all Agents in this Agency .
AgentBatchFormList	getAgentFormsForCreate(long number, Type[] agentRecordTypes) Gets the agent forms for creating a bunch of new agents.
AgentBatchFormList	getAgentFormsForUpdate(IdList agentIds) Gets the agent forms for updating an existing set of agents.
UpdateResponseList	updateAgents(AgentBatchFormList agentForms) Updates existing agents.

Methods inherited from interface org.osid.authentication.AgentAdminSession

aliasAgent, canCreateAgents, canCreateAgentWithRecordTypes, canDeleteAgent, canDeleteAgents, canManageAgentAliases, canUpdateAgent, canUpdateAgents, createAgent, deleteAgent, getAgency, getAgencyId, getAgentFormForCreate, getAgentFormForUpdate, updateAgent

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAgentFormsForCreate

AgentBatchFormList getAgentFormsForCreate(long number,
                                        Type[] agentRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the agent forms for creating a bunch of new agents.

Parameters:

number - the number of forms to retrieve

agentRecordTypes - array of agent record types to be included in each create operation or an empty list if none

Returns:

the agent forms

Throws:

NullArgumentException - agentRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createAgents

CreateResponseList createAgents(AgentBatchFormList agentForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new set of Agents. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

agentForms - the agent forms

Returns:

the create responses

Throws:

NullArgumentException - agentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgentFormsForUpdate

AgentBatchFormList getAgentFormsForUpdate(IdList agentIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the agent forms for updating an existing set of agents. A new agent form should be requested for each update transaction.

Parameters:

agentIds - the Ids of the Agent

Returns:

the agent form

Throws:

NotFoundException - an agentId is not found

NullArgumentException - agentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAgents

UpdateResponseList updateAgents(AgentBatchFormList agentForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing agents. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

agentForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - agentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAgents

DeleteResponseList deleteAllAgents()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Agents in this Agency .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAgents

DeleteResponseList deleteAgents(IdList agentIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes agents for the given Ids.

Parameters:

agentIds - the Ids of the agents to delete

Returns:

the delete responses

Throws:

NullArgumentException - agentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAgents

AliasResponseList aliasAgents(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an Id to an Agent for the purpose of creating compatibility. The primary Id of the Agent is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another agent, it is reassigned to the given entry Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.