| Interface | osid.course.registration.batch.RegistrationTargetBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.registration.RegistrationTargetAdminSession | ||
| Used By | osid.course.registration.batch.CourseRegistrationBatchManager | ||
osid.course.registration.batch.CourseRegistrationBatchProxyManager | |||
| Description |
This session creates, updates, and deletes
Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete
| ||
| Method | getRegistrationTargetFormsForCreate | ||
| Description |
Gets the registration target forms for creating a bunch
of new registration targets. A
| ||
| Parameters | osid.id.IdList | courseOfferingIds | 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 | |
| Return | osid.course.registration.batch.RegistrationTargetBatchFormList | the registration target forms | |
| Errors | NOT_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createRegistrationTargets | ||
| Description |
Creates a new set of | ||
| Parameters | osid.course.registration.batch.RegistrationTargetBatchFormList | registrationTargetForms | the registration target forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | registrationTargetForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationTargetFormsForUpdate | ||
| 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. | ||
| Parameters | osid.id.IdList | registrationTargetIds | the Ids of the RegistrationTargets |
| Return | osid.course.registration.batch.RegistrationTargetBatchFormList | the registration target forms | |
| Errors | NOT_FOUND | a registrationTargetId is not found | |
| NULL_ARGUMENT | registrationTargetIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRegistrationTargets | ||
| 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 | ||
| Parameters | osid.course.registration.batch.RegistrationTargetBatchFormList | registrationTargetForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | registrationTargetForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRegistrationTargets | ||
| Description |
Deletes all | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationTargets | ||
| Description |
Deletes registration targets for the given
| ||
| Parameters | osid.id.IdList | registrationTargetIds | the Ids of the registration targets to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | registrationTargetIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationTargetsForCourseOffering | ||
| Description |
Deletes registration targets for the given course offering. | ||
| Parameters | osid.id.Id | courseOfferingId | the Id of a course offering |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | courseOfferingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationTargetsByActivityOffering | ||
| Description |
Deletes registration targets containing the given activity offering. | ||
| Parameters | osid.id.Id | activityOfferingId | the Id of an activity offering |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | activityOfferingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasRegistrationTargets | ||
| Description |
Adds an | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT | aliasRequests is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |