Interface | osid.course.registration.RegistrationSearchSession | ||
---|---|---|---|
Implements | osid.course.registration.RegistrationQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Registrations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getRegistrationSearch | ||
Description |
Gets a registration search. | ||
Return | osid.course.registration.RegistrationSearch | the registration search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationSearchOrder | ||
Description |
Gets a registration search order. The | ||
Return | osid.course.registration.RegistrationSearchOrder | the registration search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.registration.RegistrationQuery | registrationQuery | the registration query |
osid.course.registration.RegistrationSearch | registrationSearch | the registration search | |
Return | osid.course.registration.RegistrationSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | registrationQuery or registrationSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | registrationQuery or registrationSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationQueryFromInspector | ||
Description |
Gets a registration query from an inspector. The
inspector is available from a | ||
Parameters | osid.assessment.ItemQueryInspector | registrationQueryInspector | a registration 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. |