| Interface | osid.course.registration.batch.RegistrationBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.registration.RegistrationAdminSession | ||
| 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 | getRegistrationFormsForCreate | ||
| Description | 
                     Gets the registration forms for creating a bunch of new registrations. A form is returned for supplied activity bundle and student pair.  | ||
| Parameters | osid.course.registration.batch.RegistrationPeerList | peers | a list of course offering peers | 
osid.type.Type[] | registrationRecordTypes | array of registration record types to be included in each create operation or an empty list if none | |
| Return | osid.course.registration.batch.RegistrationBatchFormList | the registration forms | |
| Errors | NOT_FOUND | an  activityBundleId  or  resourceId  is not 
found  |                 |
| NULL_ARGUMENT |  peers  or  registrationRecordTypes  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 | createRegistrations | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.course.registration.batch.RegistrationBatchFormList | registrationForms | the registration forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  registrationForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationFormsForUpdate | ||
| Description | 
                     Gets the registration forms for updating an existing set of registrations. A new registration form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | registrationIds | the  Ids  of the  Registration   | 
| Return | osid.course.registration.batch.RegistrationBatchFormList | the registration form | |
| Errors | NOT_FOUND | a  registrationId  is not found  |                 |
| NULL_ARGUMENT |  registrationIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRegistrations | ||
| Description | 
                     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 
                      | ||
| Parameters | osid.course.registration.batch.RegistrationBatchFormList | registrationForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  registrationForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRegistrations | ||
| 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 | deleteRegistrations | ||
| Description | 
                     Deletes registrations for the given   | ||
| Parameters | osid.id.IdList | registrationIds | the  Ids  of the registrations to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  registrationIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationsForActivityBundle | ||
| Description | 
                     Deletes registrations for the given activity bundle.  | ||
| Parameters | osid.id.Id | activityBundleId | the  Id  of an activity bundle  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  actviityBundleId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationsForStudent | ||
| Description | 
                     Deletes registrations for the given student.  | ||
| Parameters | osid.id.Id | resourceId | the  Id  of a student 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 | deleteRegistrationsForActivity | ||
| Description | 
                     Deletes registrations indirectly related to the given activity.  | ||
| Parameters | osid.id.Id | activityId | the  Id  of an activity  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  activityId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRegistrationsForCourseOffering | ||
| Description | 
                     Deletes registrations indirectly related to 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 | deleteIneffectiveRegistrationsByDate | ||
| Description | 
                     Deletes 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 | aliasRegistrations | ||
| 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. | |