Interface | osid.course.registration.RegistrationSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing registration searches. | ||
Method | searchAmongRegistrations | ||
Description |
Execute this search among the given list of registrations. | ||
Parameters | osid.id.IdList | registrationIds | list of courses |
Errors | NULL_ARGUMENT | registrationIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRegistrationResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.registration.RegistrationSearchOrder | registrationSearchOrder | course search order |
Errors | NULL_ARGUMENT | registrationSearchOrder is null | |
UNSUPPORTED | registrationSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationSearchRecord | ||
Description |
Gets the registration search record corresponding to
the given registration search record | ||
Parameters | osid.type.Type | registrationSearchRecordType | a course search record type |
Return | osid.course.registration.records.RegistrationSearchRecord | the registration search record | |
Errors | NULL_ARGUMENT | registrationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(registrationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |