OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionHouseQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among AuctionHouse objects. 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
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseQuery
Description

Gets an auction house query.

Returnosid.bidding.AuctionHouseQuerythe auction house query
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByQuery
Description

Gets a list of AuctionHouses matching the given search.

Parametersosid.bidding.AuctionHouseQueryauctionHouseQuerythe auction query
Returnosid.bidding.AuctionHouseListthe returned AuctionHouseList
ErrorsNULL_ARGUMENT auctionHouseQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionHouseQuery is not of this service
CompliancemandatoryThis method must be implemented.