Interface | osid.offering.CanonicalUnitSearchSession | ||
---|---|---|---|
Implements | osid.offering.CanonicalUnitQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
CanonicalUnits may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCanonicalUnitSearch | ||
Description |
Gets a canonical unit search. | ||
Return | osid.offering.CanonicalUnitSearch | the canonical unit search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitSearchOrder | ||
Description |
Gets a canonical unit search order. The | ||
Return | osid.offering.CanonicalUnitSearchOrder | the canonical unit search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.offering.CanonicalUnitQuery | canonicalUnitQuery | the canonical unit query |
osid.offering.CanonicalUnitSearch | canonicalUnitSearch | the canonical unit search | |
Return | osid.offering.CanonicalUnitSearchResults | the search results | |
Errors | NULL_ARGUMENT | canonicalUnitQuery or canonicalUnitSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | canonicalUnitQuery or canonicalUnitSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitQueryFromInspector | ||
Description |
Gets a canonical unit query from an inspector. The
inspector is available from a | ||
Parameters | osid.offering.CanonicalUnitQueryInspector | canonicalUnitQueryInspector | a canonical unit query inspector |
Return | osid.offering.CanonicalUnitQuery | the canonical unit query | |
Errors | NULL_ARGUMENT | canonicalUnitQueryInspector is null | |
UNSUPPORTED | canonicalUnitQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |