| Interface | osid.offering.rules.CanonicalUnitProcessorSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing canonical unit processor searches. | ||
| Method | searchAmongCanonicalUnitProcessors | ||
| Description |
Execute this search among the given list of canonical unit processors. | ||
| Parameters | osid.id.IdList | canonicalUnitProcessorIds | list of canonical unit processors |
| Errors | NULL_ARGUMENT | canonicalUnitProcessorIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCanonicalUnitProcessorResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.rules.CanonicalUnitProcessorSearchOrder | canonicalUnitProcessorSearchOrder | canonical unit processor search order |
| Errors | NULL_ARGUMENT | canonicalUnitProcessorSearchOrder is null | |
| UNSUPPORTED | canonicalUnitProcessorSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitProcessorSearchRecord | ||
| Description |
Gets the canonical unit processor search record
corresponding to the given canonical unit processor search
record | ||
| Parameters | osid.type.Type | canonicalUnitProcessorSearchRecordType | a canonical unit processor search record type |
| Return | osid.offering.rules.records.CanonicalUnitProcessorSearchRecord | the canonical unit processor search record | |
| Errors | NULL_ARGUMENT | canonicalUnitProcessorSearchRecordType is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(canonicalUnitProcessorSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |