| Interface | osid.control.InputSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing input searches. | ||
| Method | searchAmongInputs | ||
| Description |
Execute this search among the given list of inputs. | ||
| Parameters | osid.id.IdList | inputIds | list of inputs |
| Errors | NULL_ARGUMENT | inputIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderInputResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.control.InputSearchOrder | inputSearchOrder | input search order |
| Errors | NULL_ARGUMENT | inputSearchOrder is null | |
| UNSUPPORTED | inputSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputSearchRecord | ||
| Description |
Gets the input search record corresponding to the given
input search record | ||
| Parameters | osid.type.Type | inputSearchRecordType | an input search record type |
| Return | osid.control.records.InputSearchRecord | the input search record | |
| Errors | NULL_ARGUMENT | inputSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inputSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |