OSID Logo
OSID Specifications
course registration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.batch.RegistrationBatchAdminSession
Implementsosid.course.registration.RegistrationAdminSession
Description

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

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

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

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

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

The delete operations delete Registrations in bulk. To unmap a Registration from the current CourseCatalog, the RegistrationCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Registration itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRegistrationFormsForCreate
Description

Gets the registration forms for creating a bunch of new registrations. A form is returned for supplied activity bundle and student pair.

Parametersosid.course.registration.batch.RegistrationPeerListpeersa list of course offering peers
osid.type.Type[]registrationRecordTypesarray of registration record types to be included in each create operation or an empty list if none
Returnosid.course.registration.batch.RegistrationBatchFormListthe registration forms
ErrorsNOT_FOUNDan activityBundleId or resourceId is not found
NULL_ARGUMENT peers or registrationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRegistrations
Description

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

Parametersosid.course.registration.batch.RegistrationBatchFormListregistrationFormsthe registration forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT registrationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationFormsForUpdate
Description

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

Parametersosid.id.IdListregistrationIdsthe Ids of the Registration
Returnosid.course.registration.batch.RegistrationBatchFormListthe registration form
ErrorsNOT_FOUNDa registrationId is not found
NULL_ARGUMENT registrationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRegistrations
Description

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

Parametersosid.course.registration.batch.RegistrationBatchFormListregistrationFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT registrationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRegistrations
Description

Deletes all Registrations in this CourseCatalog .

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

Deletes registrations for the given Ids.

Parametersosid.id.IdListregistrationIdsthe Ids of the registrations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT registrationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRegistrationsForActivityBundle
Description

Deletes registrations for the given activity bundle.

Parametersosid.id.IdactivityBundleIdthe Id of an activity bundle
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT actviityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRegistrationsForStudent
Description

Deletes registrations for the given student.

Parametersosid.id.IdresourceIdthe Id of a student 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.
MethoddeleteRegistrationsForActivity
Description

Deletes registrations indirectly related to the given activity.

Parametersosid.id.IdactivityIdthe Id of an activity
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRegistrationsForCourseOffering
Description

Deletes registrations indirectly related to the given course offering.

Parametersosid.id.IdcourseOfferingIdthe Id of a course offering
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRegistrationsByDate
Description

Deletes registrations 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.
MethodaliasRegistrations
Description

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