OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerEnablerSearchSession
Implementsosid.bidding.rules.AuctionConstrainerEnablerQuerySession
Description

This session provides methods for searching among AuctionConstrainerEnabler objects. The search query is constructed using the AuctionConstrainerEnableryQuery.

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.

  • federated auction house view: searches include auction constrainer enablers in auction houses of which this auction house is an ancestor in the auction house hierarchy
  • isolated auction house view: searches are restricted to auction constrainer enablers in this auction house

AuctionConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the AuctionConstrainerEnablerQuery.

MethodgetAuctionConstrainerEnablerSearch
Description

Gets an auction constrainer enabler search.

Returnosid.bidding.rules.AuctionConstrainerEnablerSearchthe auction constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerSearchOrder
Description

Gets an auction constrainer enabler search order. The AuctionConstrainerEnablerSearchOrder is supplied to an AuctionConstrainerEnablerSearch to specify the ordering of results.

Returnosid.bidding.rules.AuctionConstrainerEnablerSearchOrderthe auction constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.bidding.rules.AuctionConstrainerEnablerQueryauctionConstrainerEnablerQuerythe auction constrainer enabler query
osid.bidding.rules.AuctionConstrainerEnablerSearchauctionConstrainerEnablerSearchthe auction constrainer enabler search
Returnosid.bidding.rules.AuctionConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auctionConstrainerEnablerQuery or auctionConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerEnablerQuery or auctionConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerQueryFromInspector
Description

Gets an auction constrainer enabler query from an inspector. The inspector is available from an AuctionConstrainerEnablerSearchResults.

Parametersosid.bidding.rules.AuctionConstrainerEnablerQueryInspectorauctionConstrainerEnablerQueryInspectoran auction constrainer enabler query inspector
Returnosid.bidding.rules.AuctionConstrainerEnablerQuerythe auction constrainer enabler query
ErrorsNULL_ARGUMENT auctionConstrainerEnablerQueryInspector is null
UNSUPPORTED auctionConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.