OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.ConvocationBatchAdminSession
Implementsosid.recognition.ConvocationAdminSession
Description

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

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

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

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

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

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

MethodgetConvocationFormsForCreate
Description

Gets the convocation forms for creating a bunch of new convocations.

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

Creates a new set of Convocations. 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.ConvocationBatchFormListconvocationFormsthe convocation forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT convocationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationFormsForUpdate
Description

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

Parametersosid.id.IdListconvocationIdsthe Ids of the Convocation
Returnosid.recognition.batch.ConvocationBatchFormListthe convocation form
ErrorsNOT_FOUNDa convocationId is not found
NULL_ARGUMENT convocationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateConvocations
Description

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

Deletes all Convocations in this Academy .

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

Deletes convocations for the given Ids.

Parametersosid.id.IdListconvocationIdsthe Ids of the convocations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT convocationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasConvocations
Description

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