| Interface | osid.voting.rules.RaceConstrainerEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.voting.rules.RaceConstrainerEnablerQuerySession | ||
| Used By | osid.voting.rules.VotingRulesManager | ||
osid.voting.rules.VotingRulesProxyManager | |||
| Description |
This session provides methods for searching among
getRaceConstrainerEnablersByQuery() is the basic
search method and returns a list of
RaceConstrainerEnablers . A more advanced search
may be performed with
getRaceConstrainerEnablersBySearch() .It accepts
a RaceConstrainerEnablerSearch in addition to the
query for the purpose of specifying additional options
affecting the entire search, such as voting.
getRaceConstrainerEnablersBySearch() returns a
RaceConstrainerEnablerSearchResults that can be
used to access the resulting
RaceConstrainerEnablerList or be used to perform
a search within the result set through
RaceConstrainerEnablerSearch .
This session defines views that offer differing behaviors for searching.
RaceConstrainerEnablers may have a query record
indicated by their respective record types. The query record
is accessed via the RaceConstrainerEnablerQuery . | ||
| Method | getRaceConstrainerEnablerSearch | ||
| Description |
Gets a race constrainer enabler search. | ||
| Return | osid.voting.rules.RaceConstrainerEnablerSearch | the race constrainer enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceConstrainerEnablerSearchOrder | ||
| Description |
Gets a race constrainer enabler search order. The
| ||
| Return | osid.voting.rules.RaceConstrainerEnablerSearchOrder | the race constrainer enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceConstrainerEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.voting.rules.RaceConstrainerEnablerQuery | raceConstrainerEnablerQuery | the race constrainer enabler query |
osid.voting.rules.RaceConstrainerEnablerSearch | raceConstrainerEnablerSearch | the race constrainer enabler search | |
| Return | osid.voting.rules.RaceConstrainerEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | raceConstrainerEnablerQuery or
raceConstrainerEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | raceConstrainerEnablerQuery or
raceConstrainerEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceConstrainerEnablerQueryFromInspector | ||
| Description |
Gets a race constrainer enabler query from an
inspector. The inspector is available from a
| ||
| Parameters | osid.voting.rules.RaceConstrainerEnablerQueryInspector | raceConstrainerEnablerQueryInspector | a race constrainer enabler query inspector |
| Return | osid.voting.rules.RaceConstrainerEnablerQuery | the race constrainer enabler query | |
| Errors | NULL_ARGUMENT | raceConstrainerEnablerQueryInspector is null | |
| UNSUPPORTED | raceConstrainerEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |