OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
subscription package
Version 3.0.0
Release Candidate Preview
| Interface | osid.subscription.DispatchSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDispatches | ||
| Description |
Gets the dispatch list resulting from a search. | ||
| Return | osid.subscription.DispatchList | the dispatch list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.subscription.DispatchQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchSearchResultsRecord | ||
| Description |
Gets the dispatch search results record corresponding to the given dispatch search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | dispatchSearchRecordType | a dispatch search record type |
| Return | osid.subscription.records.DispatchSearchResultsRecord | the dispatch search results record | |
| Errors | NULL_ARGUMENT | DispatchSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |