OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.AwardBatchAdminSession
Implementsosid.recognition.AwardAdminSession
Description

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

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

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

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

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

The delete operations delete Awards in bulk. To unmap an Award from the current Academy, the AwardAcademyAssignmentSession should be used. These delete operations attempt to remove the Award itself thus removing it from all known Academy catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetAwardFormsForCreate
Description

Gets the award forms for creating a bunch of new awards.

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

Creates a new set of Awards. 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.AwardBatchFormListawardFormsthe award forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT awardForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardFormsForUpdate
Description

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

Parametersosid.id.IdListawardIdsthe Ids of the Award
Returnosid.recognition.batch.AwardBatchFormListthe award form
ErrorsNOT_FOUNDan awardId is not found
NULL_ARGUMENT awardIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAwards
Description

Updates existing awards. 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.AwardBatchFormListawardFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT awardForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAwards
Description

Deletes all Awards in this Academy .

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

Deletes awards for the given Ids.

Parametersosid.id.IdListawardIdsthe Ids of the awards to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT awardIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAwards
Description

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