Interface | osid.offering.rules.CanonicalUnitEnablerSearchSession | ||
---|---|---|---|
Implements | osid.offering.rules.CanonicalUnitEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getCanonicalUnitEnablerSearch | ||
Description |
Gets a canonical unit enabler search. | ||
Return | osid.offering.rules.CanonicalUnitEnablerSearch | the canonical unit enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitEnablerSearchOrder | ||
Description |
Gets a canonical unit enabler search order. The | ||
Return | osid.offering.rules.CanonicalUnitEnablerSearchOrder | the canonical unit enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.offering.rules.CanonicalUnitEnablerQuery | canonicalUnitEnablerQuery | the canonical unit enabler query |
osid.offering.rules.CanonicalUnitEnablerSearch | canonicalUnitEnablerSearch | the canonical unit enabler search | |
Return | osid.offering.rules.CanonicalUnitEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | canonicalUnitEnablerQuery or
canonicalUnitEnablerSearch is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | canonicalUnitEnablerQuery or
canonicalUnitEnablerSearch is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitEnablerQueryFromInspector | ||
Description |
Gets a canonical unit enabler query from an inspector.
The inspector is available from a | ||
Parameters | osid.offering.rules.CanonicalUnitEnablerQueryInspector | canonicalUnitEnablerQueryInspector | a canonical unit enabler query inspector |
Return | osid.offering.rules.CanonicalUnitEnablerQuery | the canonical unit enabler query | |
Errors | NULL_ARGUMENT | canonicalUnitEnablerQueryInspector is null | |
UNSUPPORTED | canonicalUnitEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |