Interface | osid.course.registration.RegistrationSmartCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCourseCatalogs | ||
Description |
Tests if this user can manage smart course catalogs. A
return of true does not guarantee successful assessment. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart course catalog management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationQuery | ||
Description |
Gets a registration query. | ||
Return | osid.course.registration.RegistrationQuery | the registration query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationSearchOrder | ||
Description |
Gets a registration search order. | ||
Return | osid.course.registration.RegistrationSearchOrder | the registration search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRegistrationQuery | ||
Description |
Applies a registration query to this course catalog. | ||
Parameters | osid.course.registration.RegistrationQuery | registrationQuery | the registration query |
Errors | NULL_ARGUMENT | registrationQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | registrationQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRegistrationQuery | ||
Description |
Gets a registration query inspector for this course catalog. | ||
Return | osid.course.registration.RegistrationQueryInspector | the registration query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRegistrationSequencing | ||
Description |
Applies a registration search order to this course catalog. | ||
Parameters | osid.course.registration.RegistrationSearchOrder | registrationSearchOrder | the registration search order |
Errors | NULL_ARGUMENT | registrationSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | registrationSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationQueryFromInspector | ||
Description |
Gets a registration query from an inspector. | ||
Parameters | osid.course.registration.RegistrationQueryInspector | registrationQueryInspector | a query inspector |
Return | osid.course.registration.RegistrationQuery | the registration query | |
Errors | NULL_ARGUMENT | registrationQueryInspector is null | |
UNSUPPORTED | registrationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |