| Interface | osid.subscription.rules.DispatchProcessorSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.subscription.rules.DispatchProcessorSearchSession | ||
| Description |
The search interface for governing dispatch processor searches. | ||
| Method | searchAmongDispatchProcessors | ||
| Description |
Execute this search among the given list of dispatch processors. | ||
| Parameters | osid.id.IdList | dispatchProcessorIds | list of dispatch processors |
| Errors | NULL_ARGUMENT | dispatchProcessorIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDispatchProcessorResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.subscription.rules.DispatchProcessorSearchOrder | dispatchProcessorSearchOrder | dispatch processor search order |
| Errors | NULL_ARGUMENT | dispatchProcessorSearchOrder is null | |
| UNSUPPORTED | dispatchProcessorSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorSearchRecord | ||
| Description |
Gets the dispatch processor search record corresponding
to the given dispatch processor search record
| ||
| Parameters | osid.type.Type | dispatchProcessorSearchRecordType | a dispatch processor search record type |
| Return | osid.subscription.rules.records.DispatchProcessorSearchRecord | the dispatch processor search record | |
| Errors | NULL_ARGUMENT | dispatchProcessorSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchProcessorSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |