| Interface | osid.course.registration.batch.CourseRegistrationBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.registration.CourseRegistrationAdminSession | ||
| 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 an The Once a batch of For updates, Once a batch of The delete operations delete
| ||
| Method | getCourseRegistrationFormsForCreate | ||
| Description |
Gets the course registration forms for creating a bunch of new course registrations. A form is returned for each course offering and resource pair. | ||
| Parameters | osid.course.registration.batch.CourseRegistrationPeerList | peers | the relationship peers |
osid.type.Type[] | courseRegistrationRecordTypes | array of course registration record types to be included in each create operation or an empty list if none | |
| Return | osid.course.registration.batch.CourseRegistrationBatchFormList | the course registration forms | |
| Errors | NOT_FOUND | a registrationId or resourceId is not found | |
| NULL_ARGUMENT | peers or courseRegistrationRecordTypes 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 | createCourseRegistrations | ||
| Description |
Creates a new set of | ||
| Parameters | osid.course.registration.batch.CourseRegistrationBatchFormList | courseRegistrationForms | the course registration forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | courseRegistrationForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseRegistrationFormsForUpdate | ||
| Description |
Gets the course registration forms for updating an existing set of course registrations. A new course registration form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | courseRegistrationIds | the Ids of the CourseRegistrations |
| Return | osid.course.registration.batch.CourseRegistrationBatchFormList | the course registration form | |
| Errors | NOT_FOUND | a courseRegistrationId is not found | |
| NULL_ARGUMENT | courseRegistrationIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateCourseRegistrations | ||
| Description |
Updates existing course registrations. 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.CourseRegistrationBatchFormList | courseRegistrationForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | courseRegistrationForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllCourseRegistrations | ||
| 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 | deleteCourseRegistrations | ||
| Description |
Deletes course registrations for the given
| ||
| Parameters | osid.id.IdList | courseRegistrationIds | the Ids of the course registrations to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | courseRegistrationIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCourseRegistrationsForRegistration | ||
| Description |
Deletes course registrations for the given registration. | ||
| Parameters | osid.id.Id | registrationId | an Id of a registration |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | registrationId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCourseRegistrationsForCourseOffering | ||
| Description |
Deletes course registrations for the given course offering. | ||
| Parameters | osid.id.Id | courseOfferingId | an 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 | deleteCourseRegistrationsForStudent | ||
| Description |
Deletes course registrations for the given student resource. | ||
| Parameters | osid.id.Id | resourceId | an Id of a resource |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | resourceId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveCourseRegistrationsByDate | ||
| Description |
Deletes course registrations expired before the given date. | ||
| Parameters | osid.calendaring.DateTime | date | a date |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | date is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasCourseRegistrations | ||
| 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. | |