OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionSearchSession
Implementsosid.bidding.AuctionQuerySession
Description

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

getAuctionsByQuery() is the basic search method and returns a list of Auctions. A more advanced search may be performed with getAuctionsBySearch(). It accepts an AuctionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuctionsBySearch() returns an AuctionSearchResults that can be used to access the resulting AuctionList or be used to perform a search within the result set through AuctionSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAuctionSearch
Description

Gets an auction search.

Returnosid.bidding.AuctionSearchthe auction search
CompliancemandatoryThis method must be implemented.
MethodgetAuctionSearchOrder
Description

Gets an auction search order. The AuctionSearchOrder is supplied to an AuctionSearch to specify the ordering of results.

Returnosid.bidding.AuctionSearchOrderthe auction search order
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsBySearch
Description

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

Parametersosid.bidding.AuctionQueryauctionQuerythe auction query
osid.bidding.AuctionSearchauctionSearchthe auction search
Returnosid.bidding.AuctionSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auctionQuery or auctionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionQuery or auctionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionQueryFromInspector
Description

Gets an auction query from an inspector. The inspector is available from an AuctionSearchResults.

Parametersosid.bidding.AuctionQueryInspectorauctionQueryInspectoran auction query inspector
Returnosid.bidding.AuctionQuerythe auction query
ErrorsNULL_ARGUMENT auctionQueryInspector is null
UNSUPPORTED auctionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.