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

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

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

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

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

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

The delete operations delete ActivityRegistrations in bulk. To unmap an ActivityRegistration from the current CourseCatalog, the ActivityRegistrationCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityRegistration itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetActivityRegistrationFormsForCreate
Description

Gets the activity registration forms for creating a bunch of new activity registrations. A form is returned for each activity and resource pair.

Parametersosid.course.registration.batch.ActivityRegistrationPeerListpeersthe relationship peers
osid.type.Type[]activityRegistrationRecordTypesarray of activity registration record types to be included in each create operation or an empty list if none
Returnosid.course.registration.batch.ActivityRegistrationBatchFormListthe activity registration forms
ErrorsNOT_FOUNDa registrationId or resourceId is not found
NULL_ARGUMENT peers or activityRegistrationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateActivityRegistrations
Description

Creates a new set of ActivityRegistrations. 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.ActivityRegistrationBatchFormListactivityRegistrationFormsthe activity registration forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT activityRegistrationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationFormsForUpdate
Description

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

Parametersosid.id.IdListactivityRegistrationIdsthe Ids of the ActivityRegistration
Returnosid.course.registration.batch.ActivityRegistrationBatchFormListthe activity registration form
ErrorsNOT_FOUNDan activityRegistrationId is not found
NULL_ARGUMENT activityRegistrationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActivityRegistrations
Description

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

Deletes all ActivityRegistrations in this CourseCatalog .

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

Deletes activity registrations for the given Ids.

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

Deletes activity registrations for the given registration.

Parametersosid.id.IdregistrationIdan Id of a registration
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT registrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteActivityRegistrationsForActivity
Description

Deletes activity registrations for the given activity.

Parametersosid.id.IdactivityIdan 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.
MethoddeleteActivityRegistrationsForStudent
Description

Deletes activity registrations for the given student resource.

Parametersosid.id.IdresourceIdan Id of a 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.
MethoddeleteIneffectiveActivityRegistrationsByDate
Description

Deletes activity 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.
MethodaliasActivityRegistrations
Description

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