org.osid.authentication.batch

Interface AgencyBatchAdminSession

All Superinterfaces:

AgencyAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AgencyBatchAdminSession
extends AgencyAdminSession

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

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

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

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

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

The delete operations delete Agencies in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAgencies(AliasRequestList aliasRequests) Adds an Id to an Agency for the purpose of creating compatibility.
CreateResponseList	createAgencies(AgencyBatchFormList agencyForms) Creates a new set of Agencies.
DeleteResponseList	deleteAgencies(IdList agencyIds) Deletes agencies for the given Ids.
DeleteResponseList	deleteAllAgencies() Deletes all Agencies.
AgencyBatchFormList	getAgencyFormsForCreate(long number, Type[] agencyRecordTypes) Gets the agency forms for creating a bunch of new agencies.
AgencyBatchFormList	getAgencyFormsForUpdate(IdList agencyIds) Gets the agency forms for updating an existing set of agencies.
UpdateResponseList	updateAgencies(AgencyBatchFormList agencyForms) Updates existing agencies.

Methods inherited from interface org.osid.authentication.AgencyAdminSession

aliasAgency, canCreateAgencies, canCreateAgencyWithRecordTypes, canDeleteAgencies, canManageAgencyAliases, canUpdateAgencies, createAgency, deleteAgency, getAgencyFormForCreate, getAgencyFormForUpdate, updateAgency

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

getAgencyFormsForCreate

AgencyBatchFormList getAgencyFormsForCreate(long number,
                                          Type[] agencyRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the agency forms for creating a bunch of new agencies.

Parameters:

number - the number of forms to retrieve

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

Returns:

the agency forms

Throws:

NullArgumentException - agencyRecordTypes 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.

createAgencies

CreateResponseList createAgencies(AgencyBatchFormList agencyForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

agencyForms - the agency forms

Returns:

the create responses

Throws:

NullArgumentException - agencyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgencyFormsForUpdate

AgencyBatchFormList getAgencyFormsForUpdate(IdList agencyIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

agencyIds - the Ids of the Agency

Returns:

the agency form

Throws:

NotFoundException - an agencyId is not found

NullArgumentException - agencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAgencies

UpdateResponseList updateAgencies(AgencyBatchFormList agencyForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

agencyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - agencyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAgencies

DeleteResponseList deleteAllAgencies()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Agencies.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAgencies

DeleteResponseList deleteAgencies(IdList agencyIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes agencies for the given Ids.

Parameters:

agencyIds - the Ids of the agencies to delete

Returns:

the delete responses

Throws:

NullArgumentException - agencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAgencies

AliasResponseList aliasAgencies(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

Adds an Id to an Agency for the purpose of creating compatibility. The primary Id of the Agency is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another agency, 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.