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

This session provides methods to retrieve Auction to AuctionHouse mappings. An Auction 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
MethodcanLookupAuctionAuctionHouseMappings
Description

Tests if this user can perform lookups of auction/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.
MethoduseComparativeAuctionAuctionHouseView
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.
MethodusePlenaryAuctionAuctionHouseView
Description

A complete view of the Auction 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.
MethodgetAuctionIdsByAuctionHouse
Description

Gets the list of Auction Ids associated with an AuctionHouse.

Parametersosid.id.IdauctionHouseId Id of the AuctionHouse
Returnosid.id.IdListlist of related auction 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.
MethodgetAuctionsByAuctionHouse
Description

Gets the list of Auctions associated with an AuctionHouse.

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

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

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

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

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

Gets the AuctionHouse Ids mapped to an Auction.

Parametersosid.id.IdauctionId Id of an Auction
Returnosid.id.IdListlist of auction houses
ErrorsNOT_FOUND auctionId is not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByAuction
Description

Gets the AuctionHouses mapped to an Auction.

Parametersosid.id.IdauctionId Id of an Auction
Returnosid.bidding.AuctionHouseListlist of auction houses
ErrorsNOT_FOUND auctionId is not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.