| Interface | osid.offering.CanonicalUnitSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing canonical unit searches. | ||
| Method | searchAmongCanonicalUnits | ||
| Description |
Execute this search among the given list of canonical units. | ||
| Parameters | osid.id.IdList | canonicalUnitIds | list of canonical units |
| Errors | NULL_ARGUMENT | canonicalUnitIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCanonicalUnitResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.CanonicalUnitSearchOrder | canonicalUnitSearchOrder | canonical unit search order |
| Errors | NULL_ARGUMENT | canonicalUnitSearchOrder is null | |
| UNSUPPORTED | canonicalUnitSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitSearchRecord | ||
| Description |
Gets the record corresponding to the given canonical
unit search record | ||
| Parameters | osid.type.Type | canonicalUnitSearchRecordType | a canonical unit search record type |
| Return | osid.offering.records.CanonicalUnitSearchRecord | the canonical unit search record | |
| Errors | NULL_ARGUMENT | canonicalUnitSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(canonicalUnitSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |