| Interface | osid.course.registration.RegistrationTargetSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.course.registration.RegistrationTargetSearchSession | ||
| Description |
The search interface for governing registration target searches. | ||
| Method | searchAmongRegistrationTargets | ||
| Description |
Execute this search among the given list of registration targets. | ||
| Parameters | osid.id.IdList | registrationTargetIds | list of registration targets |
| Errors | NULL_ARGUMENT | registrationTargetIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderRegistrationTargetResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.course.registration.RegistrationTargetSearchOrder | registrationTargetSearchOrder | registration target search order |
| Errors | NULL_ARGUMENT | registrationTargetSearchOrder is null | |
| UNSUPPORTED | registrationTargetSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationTargetSearchRecord | ||
| Description |
Gets the registration target search record
corresponding to the given registration target search
record | ||
| Parameters | osid.type.Type | registrationTargetSearchRecordType | a registration target search record type |
| Return | osid.course.registration.records.RegistrationTargetSearchRecord | the registration target search record | |
| Errors | NULL_ARGUMENT | registrationTargetSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationTargetSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |