| Interface | osid.subscription.rules.DispatchEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.subscription.rules.DispatchEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatchEnablers | ||
| Description |
Gets the dispatch enabler list resulting from a search. | ||
| Return | osid.subscription.rules.DispatchEnablerList | the dispatch enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.DispatchEnablerQueryInspector | the dispatch enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchEnablerSearchResultsRecord | ||
| Description |
Gets the dispatch enabler search results record
corresponding to the given dispatch enabler search record
| ||
| Parameters | osid.type.Type | dispatchEnablerSearchRecordType | a dispatch enabler search record type |
| Return | osid.subscription.rules.records.DispatchEnablerSearchResultsRecord | the dispatch enabler search results record | |
| Errors | NULL_ARGUMENT | dispatchEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |