OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionProcessorEnablerSearchSession
Implementsosid.bidding.rules.AuctionProcessorEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAuctionProcessorEnablerSearch
Description

Gets an auction processor enabler search.

Returnosid.bidding.rules.AuctionProcessorEnablerSearchthe auction processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablerSearchOrder
Description

Gets an auction processor enabler search order. The AuctionProcessorEnablerSearchOrder is supplied to an AuctionProcessorEnablerSearch to specify the ordering of results.

Returnosid.bidding.rules.AuctionProcessorEnablerSearchOrderthe auction processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablersBySearch
Description

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

Parametersosid.bidding.rules.AuctionProcessorEnablerQueryauctionProcessorEnablerQuerythe auction processor enabler query
osid.bidding.rules.AuctionProcessorEnablerSearchauctionProcessorEnablerSearchthe auction processor enabler search
Returnosid.bidding.rules.AuctionProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auctionProcessorEnablerQuery or auctionProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionProcessorEnablerQuery or auctionProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablerQueryFromInspector
Description

Gets an auction processor enabler query from an inspector. The inspector is available from an AuctionProcessorEnablerSearchResults.

Parametersosid.bidding.rules.AuctionProcessorEnablerQueryInspectorauctionProcessorEnablerQueryInspectoran auction processor enabler query inspector
Returnosid.bidding.rules.AuctionProcessorEnablerQuerythe auction processor enabler query
ErrorsNULL_ARGUMENT auctionProcessorEnablerQueryInspector is null
UNSUPPORTED auctionProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.