org.osid.course.registration.batch

Interface ActivityRegistrationBatchAdminSession

All Superinterfaces:

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

public interface ActivityRegistrationBatchAdminSession
extends ActivityRegistrationAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasActivityRegistrations(AliasRequestList aliasRequests) Adds an Id to an ActivityRegistration for the purpose of creating compatibility.
CreateResponseList	createActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms) Creates a new set of ActivityRegistrations.
DeleteResponseList	deleteActivityRegistrations(IdList activityRegistrationIds) Deletes activity registrations for the given Ids.
DeleteResponseList	deleteActivityRegistrationsForActivity(Id activityId) Deletes activity registrations for the given activity.
DeleteResponseList	deleteActivityRegistrationsForRegistration(Id registrationId) Deletes activity registrations for the given registration.
DeleteResponseList	deleteActivityRegistrationsForStudent(Id resourceId) Deletes activity registrations for the given student resource.
DeleteResponseList	deleteAllActivityRegistrations() Deletes all ActivityRegistrations in this CourseCatalog .
DeleteResponseList	deleteIneffectiveActivityRegistrationsByDate(DateTime date) Deletes activity registrations expired before the given date.
ActivityRegistrationBatchFormList	getActivityRegistrationFormsForCreate(ActivityRegistrationPeerList peers, Type[] activityRegistrationRecordTypes) Gets the activity registration forms for creating a bunch of new activity registrations.
ActivityRegistrationBatchFormList	getActivityRegistrationFormsForUpdate(IdList activityRegistrationIds) Gets the activity registration forms for updating an existing set of activity registrations.
UpdateResponseList	updateActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms) Updates existing activity registrations.

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

aliasActivityRegistration, canCreateActivityRegistrations, canCreateActivityRegistrationWithRecordTypes, canDeleteActivityRegistrations, canManageActivityRegistrationAliases, canUpdateActivityRegistrations, createActivityRegistration, deleteActivityRegistration, getActivityRegistrationFormForCreate, getActivityRegistrationFormForUpdate, getCourseCatalog, getCourseCatalogId, updateActivityRegistration

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

getActivityRegistrationFormsForCreate

ActivityRegistrationBatchFormList getActivityRegistrationFormsForCreate(ActivityRegistrationPeerList peers,
                                                                      Type[] activityRegistrationRecordTypes)
                                                                        throws NotFoundException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

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

Parameters:

peers - the relationship peers

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

Returns:

the activity registration forms

Throws:

NotFoundException - a registrationId or resourceId is not found

NullArgumentException - peers or activityRegistrationRecordTypes 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.

createActivityRegistrations

CreateResponseList createActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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 .

Parameters:

activityRegistrationForms - the activity registration forms

Returns:

the create responses

Throws:

NullArgumentException - activityRegistrationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationFormsForUpdate

ActivityRegistrationBatchFormList getActivityRegistrationFormsForUpdate(IdList activityRegistrationIds)
                                                                        throws NotFoundException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

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.

Parameters:

activityRegistrationIds - the Ids of the ActivityRegistration

Returns:

the activity registration form

Throws:

NotFoundException - an activityRegistrationId is not found

NullArgumentException - activityRegistrationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActivityRegistrations

UpdateResponseList updateActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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 .

Parameters:

activityRegistrationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - activityRegistrationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllActivityRegistrations

DeleteResponseList deleteAllActivityRegistrations()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes all ActivityRegistrations in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityRegistrations

DeleteResponseList deleteActivityRegistrations(IdList activityRegistrationIds)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes activity registrations for the given Ids.

Parameters:

activityRegistrationIds - the Ids of the activity registrations to delete

Returns:

the delete responses

Throws:

NullArgumentException - activityRegistrationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityRegistrationsForRegistration

DeleteResponseList deleteActivityRegistrationsForRegistration(Id registrationId)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

Deletes activity registrations for the given registration.

Parameters:

registrationId - an Id of a registration

Returns:

the delete responses

Throws:

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityRegistrationsForActivity

DeleteResponseList deleteActivityRegistrationsForActivity(Id activityId)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Deletes activity registrations for the given activity.

Parameters:

activityId - an 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.

deleteActivityRegistrationsForStudent

DeleteResponseList deleteActivityRegistrationsForStudent(Id resourceId)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Deletes activity registrations for the given student resource.

Parameters:

resourceId - an Id of a 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.

deleteIneffectiveActivityRegistrationsByDate

DeleteResponseList deleteIneffectiveActivityRegistrationsByDate(DateTime date)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

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

aliasActivityRegistrations

AliasResponseList aliasActivityRegistrations(AliasRequestList aliasRequests)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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.

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.