OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.CanonicalUnitSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCanonicalUnits | ||
| Description |
Gets the canonical unit list resulting from a search. | ||
| Return | osid.offering.CanonicalUnitList | the canonical unit list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.offering.CanonicalUnitQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitSearchResultsRecord | ||
| 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.CanonicalUnitSearchResultsRecord | the canonical unit search results 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. | |