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

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

This session defines views that offer differing behaviors for searching.

  • federated auction house view: searches include auction processor 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 processor in this auction house

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

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

Tests if this user can perform AuctionProcessor 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 auction processor in auction houses which are children of this broker 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 lookups to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethodgetAuctionProcessorQuery
Description

Gets an auction processor query.

Returnosid.bidding.rules.AuctionProcessorQuerythe auction processor query
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsByQuery
Description

Gets a list of AuctionProcessors matching the given search.

Parametersosid.bidding.rules.AuctionProcessorQueryauctionProcessorQuerythe auction processor query
Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessorList
ErrorsNULL_ARGUMENT auctionProcessorQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionProcessorQuery is not of this service
CompliancemandatoryThis method must be implemented.