| Interface | osid.subscription.rules.DispatchProcessorEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.subscription.rules.DispatchProcessorEnablerSearchSession | ||
| Description |
The search interface for governing dispatch processor enabler searches. | ||
| Method | searchAmongDispatchProcessorEnablers | ||
| Description |
Execute this search among the given list of dispatch processor enablers. | ||
| Parameters | osid.id.IdList | dispatchProcessorEnablerIds | list of dispatch processor enablers |
| Errors | NULL_ARGUMENT | dispatchProcessorEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDispatchProcessorEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.subscription.rules.DispatchProcessorEnablerSearchOrder | dispatchProcessorEnablerSearchOrder | dispatch processor enabler search order |
| Errors | NULL_ARGUMENT | dispatchProcessorEnablerSearchOrder is null | |
| UNSUPPORTED | dispatchProcessorEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchProcessorEnablerSearchRecord | ||
| Description |
Gets the dispatch processor enabler search record
corresponding to the given dispatch processor enabler
search record | ||
| Parameters | osid.type.Type | dispatchProcessorEnablerSearchRecordType | a dispatch processor enabler search record type |
| Return | osid.subscription.rules.records.DispatchProcessorEnablerSearchRecord | the dispatch processor enabler search record | |
| Errors | NULL_ARGUMENT | dispatchProcessorEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchProcessorEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |