org.osid.bidding.rules

Interface AuctionConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface AuctionConstrainer
extends OsidConstrainer

An AuctionConstrainer describes the rules for constraining the bids in an auction.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionConstrainerRecord	getAuctionConstrainerRecord(Type auctionConstrainerRecordType) Gets the auction constrainer record corresponding to the given AuctionConstrainer 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

getAuctionConstrainerRecord

AuctionConstrainerRecord getAuctionConstrainerRecord(Type auctionConstrainerRecordType)
                                                     throws OperationFailedException

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

Parameters:

auctionConstrainerRecordType - the type of auction constrainer record to retrieve

Returns:

the auction constrainer record

Throws:

NullArgumentException - auctionConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.