| Interface | osid.offering.rules.CanonicalUnitEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing canonical unit enabler searches. | ||
| Method | searchAmongCanonicalUnitEnablers | ||
| Description |
Execute this search among the given list of canonical unit enablers. | ||
| Parameters | osid.id.IdList | canonicalUnitEnablerIds | list of canonical unit enablers |
| Errors | NULL_ARGUMENT | canonicalUnitEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCanonicalUnitEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.rules.CanonicalUnitEnablerSearchOrder | canonicalUnitEnablerSearchOrder | canonical unit enabler search order |
| Errors | NULL_ARGUMENT | canonicalUnitEnablerSearchOrder is null | |
| UNSUPPORTED | canonicalUnitEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitEnablerSearchRecord | ||
| Description |
Gets the canonical unit enabler search record
corresponding to the given canonical unit enabler search
record | ||
| Parameters | osid.type.Type | canonicalUnitEnablerSearchRecordType | a canonical unit enabler search record type |
| Return | osid.offering.rules.records.CanonicalUnitEnablerSearchRecord | the canonical unit enabler search record | |
| Errors | NULL_ARGUMENT | canonicalUnitEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(canonicalUnitEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |