OSID Logo
OSID Specifications
authentication batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.batch.AgencyBatchAdminSession
Implementsosid.authentication.AgencyAdminSession
Description

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.

MethodgetAgencyFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]agencyRecordTypesarray of agency record types to be included in each create operation or an empty list if none
Returnosid.authentication.batch.AgencyBatchFormListthe agency forms
ErrorsNULL_ARGUMENT agencyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAgencies
Description

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 .

Parametersosid.authentication.batch.AgencyBatchFormListagencyFormsthe agency forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT agencyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgencyFormsForUpdate
Description

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

Parametersosid.id.IdListagencyIdsthe Ids of the Agency
Returnosid.authentication.batch.AgencyBatchFormListthe agency form
ErrorsNOT_FOUNDan agencyId is not found
NULL_ARGUMENT agencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAgencies
Description

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 .

Parametersosid.authentication.batch.AgencyBatchFormListagencyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT agencyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAgencies
Description

Deletes all Agencies.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAgencies
Description

Deletes agencies for the given Ids.

Parametersosid.id.IdListagencyIdsthe Ids of the agencies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT agencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAgencies
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.