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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BidQuery can be retrieved from this session and auctionHouseped to this AuctionHouse to create a virtual collection of Bids. The bids may be sequenced using the BidSearchOrder from this session.

This AuctionHouse has a default query that matches any bid and a default search order that specifies no sequencing. The queries may be examined using a BidQueryInspector. The query may be modified by converting the inspector back to a BidQuery.

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.
MethodcanManageSmartAuctionHouses
Description

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

Returnboolean false if smart auction house management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBidQuery
Description

Gets a bid query.

Returnosid.bidding.BidQuerythe bid query
CompliancemandatoryThis method must be implemented.
MethodgetBidSearchOrder
Description

Gets a bid search order.

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

Applies a bid query to this auction house.

Parametersosid.bidding.BidQuerybidQuerythe bid query
ErrorsNULL_ARGUMENT bidQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED bidQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBidQuery
Description

Gets a bid query inspector for this auction house.

Returnosid.bidding.BidQueryInspectorthe bid query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBidSequencing
Description

Applies a bid search order to this auction house.

Parametersosid.bidding.BidSearchOrderbidSearchOrderthe bid search order
ErrorsNULL_ARGUMENT bidSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED bidSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBidQueryFromInspector
Description

Gets a bid query from an inspector.

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.