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

This session provides methods to retrieve AuctionProcessor to Auction mappings.

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

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

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

Gets the AuctionProcessor Id associated with an Auction.

Parametersosid.id.Id auctionId Id of the Auction
Returnosid.id.IdListthe auction processor Ids
ErrorsNOT_FOUND auctionId is not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsForAuction
Description

Gets the AuctionProcessor associated with an Auction.

Parametersosid.id.IdauctionId Id of the Auction
Returnosid.bidding.rules.AuctionProcessorListthe auction processors
ErrorsNOT_FOUND auctionId is not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionIdsForAuctionProcessor
Description

Gets the Auction Ids mapped to an AuctionProcessor.

Parametersosid.id.IdauctionProcessorId Id of an AuctionProcessor
Returnosid.id.IdListlist of auction 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.
MethodgetAuctionsForAuctionProcessor
Description

Gets the Auctions mapped to an AuctionProcessor.

Parametersosid.id.IdauctionProcessorId Id of an AuctionProcessor
Returnosid.bidding.AuctionListlist of auctions
ErrorsNOT_FOUND auctionProcessorId is not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.