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

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

Tests if this user can perform lookups of auction processor 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. 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.
MethoduseComparativeAuctionProcessorEnablerAuctionHouseView
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.
MethodusePlenaryAuctionProcessorEnablerAuctionHouseView
Description

A complete view of the AuctionProcessorEnabler 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.
MethodgetAuctionProcessorEnablerIdsByAuctionHouse
Description

Gets the list of AuctionProcessorEnablerIds associated with an AuctionHouse.

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

Gets the list of auction processor enablers associated with an AuctionHouse.

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

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

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

Gets the list of auction processor enablers corresponding to a list of AuctionHouses.

Parametersosid.id.IdListauctionHouseIdslist of auction house Ids
Returnosid.bidding.rules.AuctionProcessorEnablerListlist of auction processor enablers
ErrorsNULL_ARGUMENT auctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseIdsByAuctionProcessorEnabler
Description

Gets the AuctionHouse Ids mapped to an AuctionProcessorEnabler.

Parametersosid.id.IdauctionProcessorEnablerId Id of an AuctionProcessorEnabler
Returnosid.id.IdListlist of auction houses
ErrorsNOT_FOUND auctionProcessorEnablerId is not found
NULL_ARGUMENT auctionProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHousesByAuctionProcessorEnabler
Description

Gets the AuctionHouses mapped to an AuctionProcessorEnabler.

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