Interface | osid.control.rules.InputEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing input enabler searches. | ||
Method | searchAmongInputEnablers | ||
Description |
Execute this search among the given list of input enablers. | ||
Parameters | osid.id.IdList | inputEnablerIds | list of input enablers |
Errors | NULL_ARGUMENT | inputEnablerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderInputEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.control.rules.InputEnablerSearchOrder | inputEnablerSearchOrder | input enabler search order |
Errors | NULL_ARGUMENT | inputEnablerSearchOrder is null | |
UNSUPPORTED | inputEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablerSearchRecord | ||
Description |
Gets the input enabler search record corresponding to
the given input enabler search record | ||
Parameters | osid.type.Type | inputEnablerSearchRecordType | an input enabler search record type |
Return | osid.control.rules.records.InputEnablerSearchRecord | the input enabler search record | |
Errors | NULL_ARGUMENT | inputEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(inputEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |