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

This session provides methods to retrieve Bid to AuctionHouse mappings. A Bid may appear in multiple AuctionHouse objects. 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
MethodcanLookupBidAuctionHouseMappings
Description

Tests if this user can perform lookups of bid/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. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBidAuctionHouseView
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.
MethodusePlenaryBidAuctionHouseView
Description

A complete view of the Bid 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.
MethodgetBidIdsByAuctionHouse
Description

Gets the list of Bid Ids associated with an AuctionHouse.

Parametersosid.id.IdauctionHouseId Id of the AuctionHouse
Returnosid.id.IdListlist of related bid Ids
ErrorsNOT_FOUND auctionHouseId is not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsByAuctionHouse
Description

Gets the list of Bids associated with an AuctionHouse.

Parametersosid.id.IdauctionHouseId Id of the AuctionHouse
Returnosid.bidding.BidListlist of related bids
ErrorsNOT_FOUND auctionHouseId is not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidIdsByAuctionHouses
Description

Gets the list of Bid Ids corresponding to a list of AuctionHouses.

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

Gets the list of Bid corresponding to a list of AuctionHouses.

Parametersosid.id.IdListauctionHouseIdslist of auction house Ids
Returnosid.bidding.BidListlist of bids
ErrorsNULL_ARGUMENT auctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseIdsByBid
Description

Gets the AuctionHouse Ids mapped to a Bid.

Parametersosid.id.IdbidId Id of a Bid
Returnosid.id.IdListlist of auction houses
ErrorsNOT_FOUND bidId is not found
NULL_ARGUMENT bidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByBid
Description

Gets the AuctionHouses mapped to a Bid.

Parametersosid.id.IdbidId Id of a Bid
Returnosid.bidding.AuctionHouseListlist of auction houses
ErrorsNOT_FOUND bidId is not found
NULL_ARGUMENT bidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.