| Interface | osid.course.registration.request.RegistrationRequestItemCourseCatalogSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.course.registration.request.RegistrationRequestManager | ||
osid.course.registration.request.RegistrationRequestProxyManager | |||
| Description |
This session provides methods to retrieve
This lookup session defines several views:
| ||
| Method | canLookupRegistrationRequestItemCourseCatalogMappings | ||
| Description |
Tests if this user can perform lookups of registration
request item/course catalog mappings. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known lookup methods in this
session will result in a | ||
| Return | boolean | false if looking up mappings is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useComparativeRegistrationRequestItemCourseCatalogView | ||
| Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | usePlenaryRegistrationRequestItemCourseCatalogView | ||
| Description |
A complete view of the
| ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRegistrationRequestItemIdsByCourseCatalog | ||
| Description |
Gets the list of
| ||
| Parameters | osid.id.Id | courseCatalogId | Id of the CourseCatalog |
| Return | osid.id.IdList | list of related registration request item Ids | |
| Errors | NOT_FOUND | courseCatalogId is not found | |
| NULL_ARGUMENT | courseCatalogId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestItemsByCourseCatalog | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.Id | courseCatalogId | Id of the CourseCatalog |
| Return | osid.course.registration.request.RegistrationRequestItemList | list of related registration request items | |
| Errors | NOT_FOUND | courseCatalogId is not found | |
| NULL_ARGUMENT | courseCatalogId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestItemIdsByCourseCatalogs | ||
| Description |
Gets the list of
| ||
| Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
| Return | osid.id.IdList | list of registration request item Ids | |
| Errors | NULL_ARGUMENT | courseCatalogIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestItemsByCourseCatalogs | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
| Return | osid.course.registration.request.RegistrationRequestItemList | list of registration request items | |
| Errors | NULL_ARGUMENT | courseCatalogIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogIdsByRegistrationRequestItem | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | registrationRequestItemId | Id of a RegistrationRequestItem |
| Return | osid.id.IdList | list of course catalog Ids | |
| Errors | NOT_FOUND | registrationRequestItemId is not found | |
| NULL_ARGUMENT | registrationRequestItemId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogsByRegistrationRequestItem | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | registrationRequestItemId | Id of a RegistrationRequestItem |
| Return | osid.course.CourseCatalogList | list of course catalogs | |
| Errors | NOT_FOUND | registrationRequestItemId is not found | |
| NULL_ARGUMENT | registrationRequestItemId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |