OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.AcademyBatchAdminSession
Implementsosid.recognition.AcademyAdminSession
Description

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

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

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

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

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

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

MethodgetAcademyFormsForCreate
Description

Gets the academy forms for creating a bunch of new academy.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]academyRecordTypesarray of academy record types to be included in each create operation or an empty list if none
Returnosid.recognition.batch.AcademyBatchFormListthe academy forms
ErrorsNULL_ARGUMENT academyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAcademies
Description

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

Parametersosid.recognition.batch.AcademyBatchFormListacademyFormsthe academy forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT academyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademyFormsForUpdate
Description

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

Parametersosid.id.IdListacademyIdsthe Ids of the Academies
Returnosid.recognition.batch.AcademyBatchFormListthe academy form
ErrorsNOT_FOUNDa academyId is not found
NULL_ARGUMENT academyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAcademies
Description

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

Parametersosid.recognition.batch.AcademyBatchFormListacademyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT academyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAcademies
Description

Deletes all Academies.

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

Deletes academies for the given Ids.

Parametersosid.id.IdListacademyIdsthe Ids of the academies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT academyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAcademies
Description

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