OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.ConferralBatchAdminSession
Implementsosid.recognition.ConferralAdminSession
Description

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

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

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

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

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

The delete operations delete Conferrals in bulk. To unmap a Conferral from the current Academy, the ConferralAcademyAssignmentSession should be used. These delete operations attempt to remove the Conferral itself thus removing it from all known Academy catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetConferralFormsForCreate
Description

Gets the conferral forms for creating a bunch of new conferrals. A new form is retuned for each supplied award and recipient.

Parametersosid.recognition.batch.ConferralPeerListpeersa list of conferral peers
osid.type.Type[]conferralRecordTypesarray of conferral record types to be included in each create operation or an empty list if none
Returnosid.recognition.batch.ConferralBatchFormListthe conferral forms
ErrorsNOT_FOUNDan awardId or resourceId is not found
NULL_ARGUMENT peers or conferralRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateConferrals
Description

Creates a new set of Conferrals. 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.ConferralBatchFormListconferralFormsthe conferral forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT conferralForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConferralFormsForUpdate
Description

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

Parametersosid.id.IdListconferralIdsthe Ids of the Conferral
Returnosid.recognition.batch.ConferralBatchFormListthe conferral form
ErrorsNOT_FOUNDa conferralId is not found
NULL_ARGUMENT conferralIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateConferrals
Description

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

Deletes all Conferrals in this Academy .

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

Deletes conferrals for the given Ids.

Parametersosid.id.IdListconferralIdsthe Ids of the conferrals to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT conferralIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteConferralsForAward
Description

Deletes conferrals for the given award.

Parametersosid.id.IdawardIdthe Id of the award
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteConferralsForRecipient
Description

Deletes conferrals for the given recipient.

Parametersosid.id.IdresourceIdthe Id of the resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveConferralsByDate
Description

Deletes conferrals expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasConferrals
Description

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