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

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

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

A complete view of the AuctionConstrainer 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.
MethodgetAuctionConstrainerIdsByAuctionHouse
Description

Gets the list of AuctionConstrainerIds associated with an AuctionHouse.

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

Gets the list of auction constrainer associated with an AuctionHouse.

Parametersosid.id.IdauctionHouseId Id of the AuctionHouse
Returnosid.bidding.rules.AuctionConstrainerListlist of related auction constrainers
ErrorsNOT_FOUND auctionHouseId is not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerIdsByAuctionHouses
Description

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

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

Gets the list of auction constrainer corresponding to a list of AuctionHouses.

Parametersosid.id.IdListauctionHouseIdslist of auction house Ids
Returnosid.bidding.rules.AuctionConstrainerListlist of auction constrainers
ErrorsNULL_ARGUMENT auctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseIdsByAuctionConstrainer
Description

Gets the AuctionHouse Ids mapped to an AuctionConstrainer.

Parametersosid.id.IdauctionConstrainerId Id of an AuctionConstrainer
Returnosid.id.IdListlist of auction houses
ErrorsNOT_FOUND auctionConstrainerId is not found
NULL_ARGUMENT auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByAuctionConstrainer
Description

Gets the AuctionHouses mapped to an AuctionConstrainer.

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