Interface | osid.hold.rules.HoldEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getHoldEnablers | ||
Description |
Gets the | ||
Return | osid.hold.rules.HoldEnablerList | the hold enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.hold.rules.HoldEnablerQueryInspector | the hold enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerSearchResultsRecord | ||
Description |
Gets the hold enabler search results record
corresponding to the given hold enabler search record
| ||
Parameters | osid.type.Type | holdEnablerSearchRecordType | a hold enabler search record type |
Return | osid.hold.rules.records.HoldEnablerSearchResultsRecord | the hold enabler search results record | |
Errors | NULL_ARGUMENT | holdEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(holdEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |