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

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

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

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

Gets an auction constrainer enabler query.

Returnosid.bidding.rules.AuctionConstrainerEnablerQuerythe auction constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerSearchOrder
Description

Gets an auction constrainer enabler search order.

Returnosid.bidding.rules.AuctionConstrainerEnablerSearchOrderthe auction constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyAuctionConstrainerEnablerQuery
Description

Applies an auction constrainer enabler query to this auction house.

Parametersosid.bidding.rules.AuctionConstrainerEnablerQueryauctionConstrainerEnablerQuerythe auction constrainer enabler query
ErrorsNULL_ARGUMENT auctionConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auctionConstrainerEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAuctionConstrainerEnablerQuery
Description

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

Returnosid.bidding.rules.AuctionConstrainerEnablerQueryInspectorthe auction constrainer enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAuctionConstrainerEnablerSequencing
Description

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

Parametersosid.bidding.rules.AuctionConstrainerEnablerSearchOrderauctionConstrainerEnablerSearchOrderthe auction constrainer enabler search order
ErrorsNULL_ARGUMENT auctionConstrainerEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auctionConstrainerEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerQueryFromInspector
Description

Gets an auction constrainer enabler query from an inspector.

Parametersosid.bidding.rules.AuctionConstrainerEnablerQueryInspectorauctionConstrainerEnablerQueryInspectoran auction constrainer enabler query inspector
Returnosid.bidding.rules.AuctionConstrainerEnablerQuerythe auction constrainer enabler query
ErrorsNULL_ARGUMENT auctionConstrainerEnablerQueryInspector is null
UNSUPPORTED auctionConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.