OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.AuctionHouseQuerySession
Implementsosid.OsidSession
Implemented Byosid.bidding.AuctionHouseSearchSession
Used Byosid.bidding.BiddingManager
osid.bidding.BiddingProxyManager
Description

This session provides methods for searching among AuctionHouses. The search query is constructed using the AuctionHouseQuery.

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

MethodcanSearchAuctionHouses
Description

Tests if this user can perform AuctionHouse searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetAuctionHouseQuery
Description

Gets an auction house query.

Returnosid.bidding.AuctionHouseQuery the auction house query
Compliancemandatory This method must be implemented.
MethodgetAuctionHousesByQuery
Description

Gets a list of AuctionHouses matching the given search.

Parametersosid.bidding.AuctionHouseQueryauctionHouseQuery the auction query
Returnosid.bidding.AuctionHouseList the returned AuctionHouseList
ErrorsNULL_ARGUMENT auctionHouseQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auctionHouseQuery is not of this service
Compliancemandatory This method must be implemented.