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

This session provides methods to retrieve AuctionProcessorEnabler to AuctionProcessor mappings. An AuctionProcessor with multiple AuctionProcessorEnablers means any positive rule evaluation across the enablers result in an effective AuctionProcessor.

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
  • isolated auction house view: All methods in this session operate, retrieve and pertain auction processor enablers defined explicitly in the current auction house
  • federated auction house view: All methods in this session operate, retrieve and pertain to all auction processor enablers defined in this auction house and any other auction processor enablers implicitly available in this auction house through auction house inheritence.
MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupAuctionProcessorEnablerRules
Description

Tests if this user can perform lookups of auction processor enabler/auction processor 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.
MethoduseComparativeAuctionProcessorEnablerRuleView
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.
MethodusePlenaryAuctionProcessorEnablerRuleView
Description

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

Federates the view for methods in this session. A federated view will include auction processor enablers in auction houses which are children of this auction house in the auction house hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethodgetAuctionProcessorEnablerIdsForAuctionProcessor
Description

Gets the AuctionProcessorEnabler Id associated with an AuctionProcessor.

Parametersosid.id.IdauctionProcessorId Id of the AuctionProcessor
Returnosid.id.IdListthe auction processor enabler Ids
ErrorsNOT_FOUND auctionProcessorId is not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablersForAuctionProcessor
Description

Gets the AuctionProcessorEnabler associated with an AuctionProcessor.

Parametersosid.id.IdauctionProcessorId Id of the AuctionProcessor
Returnosid.bidding.rules.AuctionProcessorEnablerListthe auction processor enablers
ErrorsNOT_FOUND auctionProcessorId is not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorIdsForAuctionProcessorEnabler
Description

Gets the AuctionProcessor Ids mapped to an AuctionProcessorEnabler.

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

Gets the AuctionProcessors mapped to an AuctionProcessorEnabler.

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