OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
subscription package
Version 3.0.0
Release Candidate Preview
| Interface | osid.subscription.DispatchSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing dispatch searches. | ||
| Method | searchAmongDispatches | ||
| Description |
Execute this search among the given list of dispatches. | ||
| Parameters | osid.id.IdList | dispatchIds | list of dispatches |
| Errors | NULL_ARGUMENT | dispatchIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDispatchResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.subscription.DispatchSearchOrder | dispatchSearchOrder | dispatch search order |
| Errors | NULL_ARGUMENT | dispatchSearchOrder is null | |
| UNSUPPORTED | dispatchSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchSearchRecord | ||
| Description |
Gets the dis[atch search record corresponding to the
given dispatch search record | ||
| Parameters | osid.type.Type | dispatchSearchRecordType | a dispatch search record type |
| Return | osid.subscription.records.DispatchSearchRecord | the dispatch search 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. | |