| Interface | osid.subscription.rules.DispatchEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.subscription.rules.DispatchEnablerSearchSession | ||
| Description |
The search interface for governing dispatch enabler searches. | ||
| Method | searchAmongDispatchEnablers | ||
| Description |
Execute this search among the given list of dispatch enablers. | ||
| Parameters | osid.id.IdList | dispatchEnablerIds | list of dispatch enablers |
| Errors | NULL_ARGUMENT | dispatchEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDispatchEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.subscription.rules.DispatchEnablerSearchOrder | dispatchEnablerSearchOrder | dispatch enabler search order |
| Errors | NULL_ARGUMENT | dispatchEnablerSearchOrder is null | |
| UNSUPPORTED | dispatchEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchEnablerSearchRecord | ||
| Description |
Gets the dispatch enabler search record corresponding
to the given dispatch enabler search record
| ||
| Parameters | osid.type.Type | dispatchEnablerSearchRecordType | a dispatch enabler search record type |
| Return | osid.subscription.rules.records.DispatchEnablerSearchRecord | the dispatch enabler search record | |
| Errors | NULL_ARGUMENT | dispatchEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |