OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerSearchSession
Implementsosid.bidding.rules.AuctionConstrainerQuerySession
Description

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

getAuctionConstrainersByQuery() is the basic search method and returns a list of AuctionConstrainers. A more advanced search may be performed with getAuctionConstrainersBySearch(). It accepts an AuctionConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. getAuctionConstrainersBySearch() returns an AuctionConstrainerSearchResults that can be used to access the resulting AuctionConstrainerList or be used to perform a search within the result set through AuctionConstrainerSearch.

This session defines views that offer differing behaviors for searching.

  • federated auction house view: searches include auction constrainer 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 in this auction house

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

MethodgetAuctionConstrainerSearch
Description

Gets an auction constrainer search.

Returnosid.bidding.rules.AuctionConstrainerSearchthe auction constrainer search
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerSearchOrder
Description

Gets an auction constrainer search order. The AuctionConstrainerSearchOrder is supplied to an AuctionConstrainerSearch to specify the ordering of results.

Returnosid.bidding.rules.AuctionConstrainerSearchOrderthe auction constrainer search order
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainersBySearch
Description

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

Parametersosid.bidding.rules.AuctionConstrainerQueryauctionConstrainerQuerythe auction constrainer query
osid.bidding.rules.AuctionConstrainerSearchauctionConstrainerSearchthe auction constrainer search
Returnosid.bidding.rules.AuctionConstrainerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auctionConstrainerQuery or auctionConstrainerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerQuery or auctionConstrainerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerQueryFromInspector
Description

Gets an auction constrainer query from an inspector. The inspector is available from an AuctionConstrainerSearchResults.

Parametersosid.bidding.rules.AuctionConstrainerQueryInspectorauctionConstrainerQueryInspectoran auction constrainer query inspector
Returnosid.bidding.rules.AuctionConstrainerQuerythe auction constrainer query
ErrorsNULL_ARGUMENT auctionConstrainerQueryInspector is null
UNSUPPORTED auctionConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.