OSID Specifications
subscription rules package
Version 3.1.0
subscription rules package
Version 3.1.0
| Interface | osid.subscription.rules.DispatchConstrainerEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.subscription.rules.DispatchConstrainerEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatchConstrainerEnablers | ||
| Description |
Gets the dispatch constrainer enabler list resulting from a search. | ||
| Return | osid.subscription.rules.DispatchConstrainerEnablerList | the dispatch constrainer enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchConstrainerEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.DispatchConstrainerEnablerQueryInspector | the dispatch constrainer enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchConstrainerEnablerSearchResultsRecord | ||
| Description |
Gets the dispatch constrainer enabler search results
record corresponding to the given dispatch constrainer
enabler search record | ||
| Parameters | osid.type.Type | dispatchConstrainerEnablerSearchRecordType | a dispatch constrainer enabler search record type |
| Return | osid.subscription.rules.records.DispatchConstrainerEnablerSearchResultsRecord | the dispatch constrainer enabler search results record | |
| Errors | NULL_ARGUMENT | dispatchConstrainerEnablerSearchRecordType is
null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchConstrainerEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |