OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionProcessorSearchSession
Implementsosid.bidding.rules.AuctionProcessorQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAuctionProcessorSearch
Description

Gets an auction processor search.

Returnosid.bidding.rules.AuctionProcessorSearchthe auction processor search
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorSearchOrder
Description

Gets an auction processor search order. The AuctionProcessorSearchOrder is supplied to an AuctionProcessorSearch to specify the ordering of results.

Returnosid.bidding.rules.AuctionProcessorSearchOrderthe auction processor search order
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsBySearch
Description

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

Parametersosid.bidding.rules.AuctionProcessorQueryauctionProcessorQuerythe auction processor query
osid.bidding.rules.AuctionProcessorSearchauctionProcessorSearchthe auction processor search
Returnosid.bidding.rules.AuctionProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auctionProcessorQuery or auctionProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionProcessorQuery or auctionProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorQueryFromInspector
Description

Gets an auction processor query from an inspector. The inspector is available from an AuctionProcessorSearchResults.

Parametersosid.bidding.rules.AuctionProcessorQueryInspectorauctionProcessorQueryInspectoran auction processor query inspector
Returnosid.bidding.rules.AuctionProcessorQuerythe auction processor query
ErrorsNULL_ARGUMENT auctionProcessorQueryInspector is null
UNSUPPORTED auctionProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.