org.osid.bidding.rules

Interface AuctionConstrainerEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface AuctionConstrainerEnabler
extends OsidEnabler

An AuctionConstrainerEnabler describes the rules for making an AuctionConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionConstrainerEnablerRecord	getAuctionConstrainerEnablerRecord(Type auctionConstrainerEnablerRecordType) Gets the auction constrainer enabler record corresponding to the given AuctionConstrainerEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getAuctionConstrainerEnablerRecord

AuctionConstrainerEnablerRecord getAuctionConstrainerEnablerRecord(Type auctionConstrainerEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

auctionConstrainerEnablerRecordType - the type of auction constrainer enabler record to retrieve

Returns:

the auction constrainer enabler record

Throws:

NullArgumentException - auctionConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.