Interface | osid.configuration.rules.ValueEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing value enabler searches. | ||
Method | searchAmongValueEnablers | ||
Description |
Execute this search among the given list of value enablers. | ||
Parameters | osid.id.IdList | valueEnablerIds | list of value enablers |
Errors | NULL_ARGUMENT | valueEnablerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderValueEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.configuration.rules.ValueEnablerSearchOrder | valueEnablerSearchOrder | value enabler search order |
Errors | NULL_ARGUMENT | valueEnablerSearchOrder is null | |
UNSUPPORTED | valueEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerSearchRecord | ||
Description |
Gets the value enabler search record corresponding to
the given value enabler search record | ||
Parameters | osid.type.Type | valueEnablerSearchRecordType | a value enabler search record type |
Return | osid.configuration.rules.records.ValueEnablerSearchRecord | the value enabler search record | |
Errors | NULL_ARGUMENT | valueEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(valueEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |