OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Interfaceosid.bidding.rules.BidEnablerAuctionHouseSession
Implementsosid.OsidSession
Used Byosid.bidding.rules.BiddingRulesManager
osid.bidding.rules.BiddingRulesProxyManager
Description

This session provides methods to retrieve BidEnabler to AuctionHouse mappings. A BidEnabler may appear in multiple AuctionHouse obje cts. Each auction house may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupBidEnablerAuctionHouseMappings
Description

Tests if this user can perform lookups of bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnbooleanfalse if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBidEnablerAuctionHouseView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBidEnablerAuctionHouseView
Description

A complete view of the BidEnabler and AuctionHouse returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetBidEnablerIdsByAuctionHouse
Description

Gets the list of BidEnabler Ids associated with an AuctionHouse .

Parametersosid.id.IdauctionHouseIdId of the AuctionHouse
Returnosid.id.IdListlist of related bid enabler Ids
ErrorsNOT_FOUNDauctionHouseId is not found
NULL_ARGUMENTauctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidEnablersByAuctionHouse
Description

Gets the list of BidEnablers associated with an AuctionHouse .

Parametersosid.id.IdauctionHouseIdId of the AuctionHouse
Returnosid.bidding.rules.BidEnablerListlist of related bid enablers
ErrorsNOT_FOUNDauctionHouseId is not found
NULL_ARGUMENTauctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidEnablerIdsByAuctionHouses
Description

Gets the list of BidEnabler Ids corresponding to a list of Auction Houses .

Parametersosid.id.IdListauctionHouseIdslist of auction house Ids
Returnosid.id.IdListlist of bid enabler Ids
ErrorsNULL_ARGUMENTauctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidEnablersByAuctionHouses
Description

Gets the list of BidEnablers corresponding to a list of Auction Houses .

Parametersosid.id.IdListauctionHouseIdslist of auction house Ids
Returnosid.bidding.rules.BidEnablerListlist of bid enablers
ErrorsNULL_ARGUMENTauctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseIdsByBidEnabler
Description

Gets the AuctionHouse Ids mapped to a BidEnabler .

Parametersosid.id.IdbidEnablerIdId of a BidEnabler
Returnosid.id.IdListlist of auction house Ids
ErrorsNOT_FOUNDbidEnablerId is not found
NULL_ARGUMENTbidEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByBidEnabler
Description

Gets the AuctionHouses mapped to a BidEnabler .

Parametersosid.id.IdbidEnablerIdId of a BidEnabler
Returnosid.bidding.AuctionHouseListlist of auction houses
ErrorsNOT_FOUNDbidEnablerId is not found
NULL_ARGUMENTbidEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.