| Interface | osid.subscription.rules.DispatchConstrainerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.subscription.rules.DispatchConstrainerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatchConstrainers | ||
| Description |
Gets the dispatch constrainer list resulting from a search. | ||
| Return | osid.subscription.rules.DispatchConstrainerList | the dispatch constrainer list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchConstrainerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.DispatchConstrainerQueryInspector | the dispatch constrainer query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchConstrainerSearchResultsRecord | ||
| Description |
Gets the dispatch constrainer search results record
corresponding to the given dispatch constrainer search
record | ||
| Parameters | osid.type.Type | dispatchConstrainerSearchRecordType | a dispatch constrainer search record type |
| Return | osid.subscription.rules.records.DispatchConstrainerSearchResultsRecord | the dispatch constrainer search results record | |
| Errors | NULL_ARGUMENT | dispatchConstrainerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchConstrainerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |