| Interface | osid.course.registration.RegistrationCourseCatalogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignRegistrations | ||
| Description |
Tests if this user can alter registration/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignRegistrationToCourseCatalog | ||
| Description |
Tests if this user can alter registration/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
| Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | courseCatalogId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCatalogIds | ||
| Description |
Gets a list of course catalogs including and under the given course catalog node in which any registration can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
| Return | osid.id.IdList | list of assignable course catalog Ids | |
| Errors | NULL_ARGUMENT | courseCatalogId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCtalogIdsForRegistration | ||
| Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific registration can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | registrationId | the Id of the Registration | |
| Return | osid.id.IdList | list of assignable course catalog Ids | |
| Errors | NULL_ARGUMENT | courseCatalogId or registrationId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRegistrationToCourseCatalog | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | registrationId | the Id of the Registration |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | ALREADY_EXISTS | registrationId is already assigned to courseCatalogId
| |
| NOT_FOUND | registrationId or courseCatalogId not found | ||
| NULL_ARGUMENT | registrationId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRegistrationFromCourseCatalog | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | registrationId | the Id of the Registration |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | NOT_FOUND | registrationId or courseCatalogId not found
or registrationId not assigned to courseCatalogId
| |
| NULL_ARGUMENT | registrationId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRegistrationToCourseCatalog | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | registrationId | the Id of the Registration |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
| Errors | NOT_FOUND | registrationId, fromCourseCatalogId, or
toCourseCatalogId not found or registrationId not
mapped to fromCourseCatalogId | |
| NULL_ARGUMENT | registrationId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |