| Interface | osid.offering.rules.OfferingConstrainerEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.offering.rules.OfferingConstrainerEnablerQuerySession | ||
| Used By | osid.offering.rules.OfferingRulesManager | ||
osid.offering.rules.OfferingRulesProxyManager | |||
| Description |
This session provides methods for searching among
getOfferingConstrainerEnablersByQuery() is the
basic search method and returns a list of
OfferingConstrainerEnablers. A more advanced
search may be performed with
getOfferingConstrainerEnablersBySearch().It
accepts an OfferingConstrainerEnablerSearch in
addition to the query for the purpose of specifying additional
options affecting the entire search, such as offering.
getOfferingConstrainerEnablersBySearch() returns
an OfferingConstrainerEnablerSearchResults that
can be used to access the resulting
OfferingConstrainerEnablerList or be used to
perform a search within the result set through
OfferingConstrainerEnablerSearch.
This session defines views that offer differing behaviors for searching.
OfferingConstrainerEnablers may have a query
record indicated by their respective record types. The query
record is accessed via the
OfferingConstrainerEnablerQuery. | ||
| Method | getOfferingConstrainerEnablerSearch | ||
| Description |
Gets an offering constrainer enabler search. | ||
| Return | osid.offering.rules.OfferingConstrainerEnablerSearch | the offering constrainer enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingConstrainerEnablerSearchOrder | ||
| Description |
Gets an offering constrainer enabler search order. The
| ||
| Return | osid.offering.rules.OfferingConstrainerEnablerSearchOrder | the offering constrainer enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingConstrainerEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.offering.rules.OfferingConstrainerEnablerQuery | offeringConstrainerEnablerQuery | the offering constrainer enabler query |
osid.offering.rules.OfferingConstrainerEnablerSearch | offeringConstrainerEnablerSearch | the offering constrainer enabler search | |
| Return | osid.offering.rules.OfferingConstrainerEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | offeringConstrainerEnablerQuery or
offeringConstrainerEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | offeringConstrainerEnablerQuery or
offeringConstrainerEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingConstrainerEnablerQueryFromInspector | ||
| Description |
Gets an offering constrainer enabler query from an
inspector. The inspector is available from an
| ||
| Parameters | osid.offering.rules.OfferingConstrainerEnablerQueryInspector | offeringConstrainerEnablerQueryInspector | an offering constrainer enabler query inspector |
| Return | osid.offering.rules.OfferingConstrainerEnablerQuery | the offering constrainer enabler query | |
| Errors | NULL_ARGUMENT | offeringConstrainerEnablerQueryInspector is null | |
| UNSUPPORTED | offeringConstrainerEnablerQueryInspector is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |