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

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

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.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchAuctions
Description

Tests if this user can perform Auction lookups. 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.
MethoduseFederatedAuctionHouseView
Description

Federates the view for methods in this session. A federated view will include auctions in auction houses which are children of this auction house in the auction house hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethodgetAuctionQuery
Description

Gets an auction query.

Returnosid.bidding.AuctionQuerythe auction query
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByQuery
Description

Gets a list of Auctions matching the given search.

Parametersosid.bidding.AuctionQueryauctionQuerythe auction query
Returnosid.bidding.AuctionListthe returned AuctionList
ErrorsNULL_ARGUMENT auctionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionQuery is not of this service
CompliancemandatoryThis method must be implemented.