OSID Logo
OSID Specifications
bidding rules package
Version 3.1.0
Interfaceosid.bidding.rules.AuctionConstrainerQuerySession
Implementsosid.OsidSession
Implemented Byosid.bidding.rules.AuctionConstrainerSearchSession
Used Byosid.bidding.rules.BiddingRulesManager
osid.bidding.rules.BiddingRulesProxyManager
Description

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

This session defines views that offer differing behaviors for searching.

  • federated auction house view: searches include auction constrainer in auction houses of which this auction house is an ancestor in the auction house hierarchy
  • isolated auction house view: searches are restricted to auction constrainer in this auction house

Auction constrainer may have a query record indicated by their respective record types. The query record is accessed via the AuctionConstrainerQuery.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Id the AuctionHouse Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHouse the auction house
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSearchAuctionConstrainers
Description

Tests if this user can perform AuctionConstrainer 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
Compliancemandatory This method must be implemented.
MethoduseFederatedAuctionHouseView
Description

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

Compliancemandatory This method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

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

Compliancemandatory This method is must be implemented.
MethodgetAuctionConstrainerQuery
Description

Gets an auction constrainer query.

Returnosid.bidding.rules.AuctionConstrainerQuery the auction constrainer query
Compliancemandatory This method must be implemented.
MethodgetAuctionConstrainersByQuery
Description

Gets a list of AuctionConstrainers matching the given search.

Parametersosid.bidding.rules.AuctionConstrainerQueryauctionConstrainerQuery the auction constrainer query
Returnosid.bidding.rules.AuctionConstrainerList the returned AuctionConstrainerList
ErrorsNULL_ARGUMENT auctionConstrainerQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auctionConstrainerQuery is not of this service
Compliancemandatory This method must be implemented.