| Interface | osid.subscription.rules.DispatchProcessorSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.subscription.rules.DispatchProcessorSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatchProcessors | ||
| Description |
Gets the dispatch processor list resulting from a search. | ||
| Return | osid.subscription.rules.DispatchProcessorList | the dispatch processor list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.DispatchProcessorQueryInspector | the dispatch processor query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorSearchResultsRecord | ||
| Description |
Gets the dispatch processor search results record
corresponding to the given dispatch processor search
record | ||
| Parameters | osid.type.Type | dispatchProcessorSearchRecordType | a dispatch processor search record type |
| Return | osid.subscription.rules.records.DispatchProcessorSearchResultsRecord | the dispatch processor search results record | |
| Errors | NULL_ARGUMENT | dispatchProcessorSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchProcessorSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |