org.osid.bidding.rules

Interface AuctionProcessorEnabler

All Superinterfaces:

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

public interface AuctionProcessorEnabler
extends OsidEnabler

An AuctionProcessorEnabler describes the rules for making an AuctionProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionProcessorEnablerRecord	getAuctionProcessorEnablerRecord(Type auctionProcessorEnablerRecordType) Gets the auction processor enabler record corresponding to the given AuctionProcessorEnabler 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

getAuctionProcessorEnablerRecord

AuctionProcessorEnablerRecord getAuctionProcessorEnablerRecord(Type auctionProcessorEnablerRecordType)
                                                               throws OperationFailedException

Gets the auction processor enabler record corresponding to the given AuctionProcessorEnabler 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:

auctionProcessorEnablerRecordType - the type of auction processor enabler record to retrieve

Returns:

the auction processor enabler record

Throws:

NullArgumentException - auctionProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.