| Interface | osid.bidding.rules.AuctionConstrainerEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.bidding.rules.AuctionConstrainerEnablerQuerySession | ||
| Used By | osid.bidding.rules.BiddingRulesManager | ||
osid.bidding.rules.BiddingRulesProxyManager | |||
| Description |
This session provides methods for searching among
getAuctionConstrainerEnablersByQuery() is the
basic search method and returns a list of
AuctionConstrainerEnablers . A more advanced
search may be performed with
getAuctionConstrainerEnablersBySearch() .It
accepts an AuctionConstrainerEnablerSearch in
addition to the query for the purpose of specifying additional
options affecting the entire search, such as bidding.
getAuctionConstrainerEnablersBySearch() returns
an AuctionConstrainerEnablerSearchResults that
can be used to access the resulting
AuctionConstrainerEnablerList or be used to
perform a search within the result set through
AuctionConstrainerEnablerSearch .
This session defines views that offer differing behaviors for searching.
AuctionConstrainerEnablers may have a query
record indicated by their respective record types. The query
record is accessed via the
AuctionConstrainerEnablerQuery . | ||
| Method | getAuctionConstrainerEnablerSearch | ||
| Description |
Gets an auction constrainer enabler search. | ||
| Return | osid.bidding.rules.AuctionConstrainerEnablerSearch | the auction constrainer enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionConstrainerEnablerSearchOrder | ||
| Description |
Gets an auction constrainer enabler search order. The
| ||
| Return | osid.bidding.rules.AuctionConstrainerEnablerSearchOrder | the auction constrainer enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionConstrainerEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.bidding.rules.AuctionConstrainerEnablerQuery | auctionConstrainerEnablerQuery | the auction constrainer enabler query |
osid.bidding.rules.AuctionConstrainerEnablerSearch | auctionConstrainerEnablerSearch | the auction constrainer enabler search | |
| Return | osid.bidding.rules.AuctionConstrainerEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | auctionConstrainerEnablerQuery or
auctionConstrainerEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auctionConstrainerEnablerQuery or
auctionConstrainerEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionConstrainerEnablerQueryFromInspector | ||
| Description |
Gets an auction constrainer enabler query from an
inspector. The inspector is available from an
| ||
| Parameters | osid.bidding.rules.AuctionConstrainerEnablerQueryInspector | auctionConstrainerEnablerQueryInspector | an auction constrainer enabler query inspector |
| Return | osid.bidding.rules.AuctionConstrainerEnablerQuery | the auction constrainer enabler query | |
| Errors | NULL_ARGUMENT | auctionConstrainerEnablerQueryInspector is null | |
| UNSUPPORTED | auctionConstrainerEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |