| Interface | osid.course.registration.RegistrationTargetCourseCatalogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.course.registration.CourseRegistrationManager | ||
osid.course.registration.CourseRegistrationProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignRegistrationTargets | ||
| Description |
Tests if this user can alter registration target/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 | canAssignRegistrationTargetToCourseCatalog | ||
| Description |
Tests if this user can alter registration target/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 target 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 | getAssignableCourseCatalogIdsForRegistrationTarget | ||
| Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific registration target can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | registrationTargetId | the Id of the RegistrationTarget | |
| Return | osid.id.IdList | list of assignable course catalog Ids | |
| Errors | NULL_ARGUMENT | courseCatalogId or registrationTargetId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRegistrationTargetToCourseCatalog | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | registrationTargetId | the Id of the RegistrationTarget |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | ALREADY_EXISTS | registrationTargetId is already assigned to
courseCatalogId | |
| NOT_FOUND | registrationTargetId or courseCatalogId not found | ||
| NULL_ARGUMENT | registrationTargetId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRegistrationTargetFromCourseCatalog | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | registrationTargetId | the Id of the RegistrationTarget |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | NOT_FOUND | registrationTargetId or courseCatalogId not found
or registrationTargetId not assigned to
courseCatalogId | |
| NULL_ARGUMENT | registrationTargetId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRegistrationTargetToCourseCatalog | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | registrationTargetId | the Id of the RegistrationTarget |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
| Errors | ALREADY_EXISTS | registrationTargetId already assigned to
tocourseCatalogId | |
| NOT_FOUND | registrationTargetId, fromCourseCatalogId , or
toCourseCatalogeId not found or registrationTargetId
not mapped to fromCourseCatalogId | ||
| NULL_ARGUMENT | registrationTargetId, fromCourseCatalogId , or
toCourseCatalogId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |