| Interface | osid.subscription.rules.DispatchConstrainerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.subscription.rules.DispatchConstrainerSearchSession | ||
| Description |
The search interface for governing dispatch constrainer searches. | ||
| Method | searchAmongDispatchConstrainers | ||
| Description |
Execute this search among the given list of dispatch constrainers. | ||
| Parameters | osid.id.IdList | dispatchConstrainerIds | list of dispatch constrainer |
| Errors | NULL_ARGUMENT | dispatchConstrainerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDispatchConstrainerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.subscription.rules.DispatchConstrainerSearchOrder | dispatchConstrainerSearchOrder | dispatch constrainer search order |
| Errors | NULL_ARGUMENT | dispatchConstrainerSearchOrder is null | |
| UNSUPPORTED | dispatchConstrainerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchConstrainerSearchRecord | ||
| Description |
Gets the dispatch constrainer search record
corresponding to the given dispatch constrainer search
record | ||
| Parameters | osid.type.Type | dispatchConstrainerSearchRecordType | a dispatch constrainer search record type |
| Return | osid.subscription.rules.records.DispatchConstrainerSearchRecord | the dispatch constrainer search record | |
| Errors | NULL_ARGUMENT | dispatchConstrainerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchConstrainerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |