org.osid.course.registration.batch

Interface RegistrationBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, RegistrationAdminSession

public interface RegistrationBatchAdminSession
extends RegistrationAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRegistrations(AliasRequestList aliasRequests) Adds an Id to a Registration for the purpose of creating compatibility.
CreateResponseList	createRegistrations(RegistrationBatchFormList registrationForms) Creates a new set of Registrations.
DeleteResponseList	deleteAllRegistrations() Deletes all Registrations in this CourseCatalog .
DeleteResponseList	deleteIneffectiveRegistrationsByDate(DateTime date) Deletes registrations expired before the given date.
DeleteResponseList	deleteRegistrations(IdList registrationIds) Deletes registrations for the given Ids.
DeleteResponseList	deleteRegistrationsForActivity(Id activityId) Deletes registrations indirectly related to the given activity.
DeleteResponseList	deleteRegistrationsForActivityBundle(Id activityBundleId) Deletes registrations for the given activity bundle.
DeleteResponseList	deleteRegistrationsForCourseOffering(Id courseOfferingId) Deletes registrations indirectly related to the given course offering.
DeleteResponseList	deleteRegistrationsForStudent(Id resourceId) Deletes registrations for the given student.
RegistrationBatchFormList	getRegistrationFormsForCreate(RegistrationPeerList peers, Type[] registrationRecordTypes) Gets the registration forms for creating a bunch of new registrations.
RegistrationBatchFormList	getRegistrationFormsForUpdate(IdList registrationIds) Gets the registration forms for updating an existing set of registrations.
UpdateResponseList	updateRegistrations(RegistrationBatchFormList registrationForms) Updates existing registrations.

Methods inherited from interface org.osid.course.registration.RegistrationAdminSession

aliasRegistration, canCreateRegistrations, canCreateRegistrationWithRecordTypes, canDeleteRegistrations, canManageRegistrationAliases, canUpdateRegistrations, createRegistration, deleteRegistration, getCourseCatalog, getCourseCatalogId, getRegistrationFormForCreate, getRegistrationFormForUpdate, updateRegistration

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRegistrationFormsForCreate

RegistrationBatchFormList getRegistrationFormsForCreate(RegistrationPeerList peers,
                                                      Type[] registrationRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

peers - a list of course offering peers

registrationRecordTypes - array of registration record types to be included in each create operation or an empty list if none

Returns:

the registration forms

Throws:

NotFoundException - an activityBundleId or resourceId is not found

NullArgumentException - peers or registrationRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createRegistrations

CreateResponseList createRegistrations(RegistrationBatchFormList registrationForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

registrationForms - the registration forms

Returns:

the create responses

Throws:

NullArgumentException - registrationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRegistrationFormsForUpdate

RegistrationBatchFormList getRegistrationFormsForUpdate(IdList registrationIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

registrationIds - the Ids of the Registration

Returns:

the registration form

Throws:

NotFoundException - a registrationId is not found

NullArgumentException - registrationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRegistrations

UpdateResponseList updateRegistrations(RegistrationBatchFormList registrationForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

registrationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - registrationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRegistrations

DeleteResponseList deleteAllRegistrations()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all Registrations in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRegistrations

DeleteResponseList deleteRegistrations(IdList registrationIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes registrations for the given Ids.

Parameters:

registrationIds - the Ids of the registrations to delete

Returns:

the delete responses

Throws:

NullArgumentException - registrationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRegistrationsForActivityBundle

DeleteResponseList deleteRegistrationsForActivityBundle(Id activityBundleId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes registrations for the given activity bundle.

Parameters:

activityBundleId - the Id of an activity bundle

Returns:

the delete responses

Throws:

NullArgumentException - actviityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRegistrationsForStudent

DeleteResponseList deleteRegistrationsForStudent(Id resourceId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes registrations for the given student.

Parameters:

resourceId - the Id of a student resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRegistrationsForActivity

DeleteResponseList deleteRegistrationsForActivity(Id activityId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes registrations indirectly related to the given activity.

Parameters:

activityId - the Id of an activity

Returns:

the delete responses

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRegistrationsForCourseOffering

DeleteResponseList deleteRegistrationsForCourseOffering(Id courseOfferingId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes registrations indirectly related to the given course offering.

Parameters:

courseOfferingId - the Id of a course offering

Returns:

the delete responses

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRegistrationsByDate

DeleteResponseList deleteIneffectiveRegistrationsByDate(DateTime date)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes registrations expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasRegistrations

AliasResponseList aliasRegistrations(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.