OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.BidSearchSession
Implementsosid.bidding.BidQuerySession
Description

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

getBidsByQuery() is the basic search method and returns a list of Bids. A more advanced search may be performed with getBidsBySearch(). It accepts a BidSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBidsBySearch() returns a BidSearchResults that can be used to access the resulting BidList or be used to perform a search within the result set through BidSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetBidSearch
Description

Gets a bid search.

Returnosid.bidding.BidSearchthe bid search
CompliancemandatoryThis method must be implemented.
MethodgetBidSearchOrder
Description

Gets a bid search order. The BidSearchOrder is supplied to a BidSearch to specify the ordering of results.

Returnosid.bidding.BidSearchOrderthe bid search order
CompliancemandatoryThis method must be implemented.
MethodgetBidsBySearch
Description

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

Parametersosid.bidding.BidQuerybidQuerythe bid query
osid.bidding.BidSearchbidSearchthe bid search
Returnosid.bidding.BidSearchResultsthe returned search results
ErrorsNULL_ARGUMENT bidQuery or bidSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED bidQuery or bidSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBidQueryFromInspector
Description

Gets a bid query from an inspector. The inspector is available from a BidSearchResults.

Parametersosid.bidding.BidQueryInspectorbidQueryInspectora bid query inspector
Returnosid.bidding.BidQuerythe bid query
ErrorsNULL_ARGUMENT bidQueryInspector is null
UNSUPPORTED bidQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.