OSID Logo
OSID Specifications
course registration batch package
Version 3.1.0
Interfaceosid.course.registration.batch.RegistrationTargetBatchAdminSession
Implementsosid.course.registration.RegistrationTargetAdminSession
Used Byosid.course.registration.batch.CourseRegistrationBatchManager
osid.course.registration.batch.CourseRegistrationBatchProxyManager
Description

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

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

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

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

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

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

MethodgetRegistrationTargetFormsForCreate
Description

Gets the registration target forms for creating a bunch of new registration targets. A RegistrationTargetForm is returned for each supplied course offering.

Parametersosid.id.IdListcourseOfferingIds a list of course offering Ids
osid.type.Type[]registrationTargetRecordTypes array of registration target record types to be included in each create operation or an empty list if none
Returnosid.course.registration.batch.RegistrationTargetBatchFormList the registration target forms
ErrorsNOT_FOUND a courseOfferingId is not found
NULL_ARGUMENT courseOfferingIds or registrationTargetRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateRegistrationTargets
Description

Creates a new set of RegistrationTargets. 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.RegistrationTargetBatchFormListregistrationTargetForms the registration target forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT registrationTargetForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetRegistrationTargetFormsForUpdate
Description

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

Parametersosid.id.IdListregistrationTargetIds the Ids of the RegistrationTargets
Returnosid.course.registration.batch.RegistrationTargetBatchFormList the registration target forms
ErrorsNOT_FOUND a registrationTargetId is not found
NULL_ARGUMENT registrationTargetIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateRegistrationTargets
Description

Updates existing registration targets. 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.RegistrationTargetBatchFormListregistrationTargetForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT registrationTargetForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllRegistrationTargets
Description

Deletes all RegistrationTargets in this CourseCatalog.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteRegistrationTargets
Description

Deletes registration targets for the given Ids.

Parametersosid.id.IdListregistrationTargetIds the Ids of the registration targets to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT registrationTargetIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteRegistrationTargetsForCourseOffering
Description

Deletes registration targets for the given course offering.

Parametersosid.id.IdcourseOfferingId the Id of a course offering
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteRegistrationTargetsByActivityOffering
Description

Deletes registration targets containing the given activity offering.

Parametersosid.id.IdactivityOfferingId the Id of an activity offering
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT activityOfferingId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasRegistrationTargets
Description

Adds an Id to a RegistrationTarget for the purpose of creating compatibility. The primary Id of the RegistrationTarget is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another registration target, it is reassigned to the given registration target Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.