OSID Specifications
subscription rules package
Version 3.0.0
subscription rules package
Version 3.0.0
| Interface | osid.subscription.rules.DispatchProcessorEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.subscription.rules.DispatchProcessorEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatchProcessorEnablers | ||
| Description |
Gets the dispatch processor enabler list resulting from a search. | ||
| Return | osid.subscription.rules.DispatchProcessorEnablerList | the dispatch processor enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.DispatchProcessorEnablerQueryInspector | the dispatch processor enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorEnablerSearchResultsRecord | ||
| Description |
Gets the dispatch processor enabler search results
record corresponding to the given dispatch processor
enabler search record | ||
| Parameters | osid.type.Type | dispatchProcessorEnablerSearchRecordType | a dispatch processor enabler search record type |
| Return | osid.subscription.rules.records.DispatchProcessorEnablerSearchResultsRecord | the dispatch processor enabler search results record | |
| Errors | NULL_ARGUMENT | dispatchProcessorEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchProcessorEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |