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

This session manages queries and sequencing to create "smart" dynamic auction houses. An AuctionProcessorEnablerQuery can be retrieved from this session and mapped to this AuctionHouse to create a virtual collection of auction processor enablers. The auction processor enablers may be sequenced using the AuctionProcessorEnablerSearchOrder from this session.

This AuctionHouse has a default query that matches any auction processor enabler and a default search order that specifies no sequencing. The queries may be examined using an AuctionProcessorEnablerQueryInspector. The query may be modified by converting the inspector back to an AuctionProcessorEnablerQuery.

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

Gets an auction processor enabler query.

Returnosid.bidding.rules.AuctionProcessorEnablerQuerythe auction processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablerSearchOrder
Description

Gets an auction processor enabler search order.

Returnosid.bidding.rules.AuctionProcessorEnablerSearchOrderthe auction processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyAuctionProcessorEnablerQuery
Description

Applies an auction processor enabler query to this auction house.

Parametersosid.bidding.rules.AuctionProcessorEnablerQueryauctionProcessorEnablerQuerythe auction processor enabler query
ErrorsNULL_ARGUMENT auctionProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auctionProcessorEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAuctionProcessorEnablerQuery
Description

Gets an auction processor enabler query inspector for this auction house.

Returnosid.bidding.rules.AuctionProcessorEnablerQueryInspectorthe auction processor enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAuctionProcessorEnablerSequencing
Description

Applies an auction processor enabler search order to this auction house.

Parametersosid.bidding.rules.AuctionProcessorEnablerSearchOrderauctionProcessorEnablerSearchOrderthe auction processor enabler search order
ErrorsNULL_ARGUMENT auctionProcessorEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auctionProcessorEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablerQueryFromInspector
Description

Gets an auction processor enabler query from an inspector.

Parametersosid.bidding.rules.AuctionProcessorEnablerQueryInspectorauctionProcessorEnablerQueryInspectoran auction processor enabler query inspector
Returnosid.bidding.rules.AuctionProcessorEnablerQuerythe auction processor enabler query
ErrorsNULL_ARGUMENT auctionProcessorEnablerQueryInspector is null
UNSUPPORTED auctionProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.