Interface | osid.configuration.rules.ValueEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getValueEnablers | ||
Description |
Gets the | ||
Return | osid.configuration.rules.ValueEnablerList | the value enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.configuration.rules.ValueEnablerQueryInspector | the value enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerSearchResultsRecord | ||
Description |
Gets the value enabler search results 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.ValueEnablerSearchResultsRecord | the value enabler search results record | |
Errors | NULL_ARGUMENT | valueEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(valueEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |