org.osid.bidding.rules

Interface AuctionProcessor

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule

public interface AuctionProcessor
extends OsidProcessor

An AuctionProcessor describes the rules for running an auction.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionProcessorRecord	getAuctionProcessorRecord(Type auctionProcessorRecordType) Gets the auction processor record corresponding to the given AuctionProcessor record Type.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getAuctionProcessorRecord

AuctionProcessorRecord getAuctionProcessorRecord(Type auctionProcessorRecordType)
                                                 throws OperationFailedException

Gets the auction processor record corresponding to the given AuctionProcessor record Type. This method is used to retrieve an object implementing the requested record. The auctionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(auctionRecordType) is true .

Parameters:

auctionProcessorRecordType - the type of auction processor record to retrieve

Returns:

the auction processor record

Throws:

NullArgumentException - auctionProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.