org.osid.ordering.rules

Interface PriceEnabler

All Superinterfaces:

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

public interface PriceEnabler
extends OsidEnabler

A PriceEnabler describes the rules for making a Price effective.

Method Summary

Methods

Modifier and Type	Method and Description
PriceEnablerRecord	getPriceEnablerRecord(Type priceEnablerRecordType) Gets the price enabler record corresponding to the given PriceEnabler 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

getPriceEnablerRecord

PriceEnablerRecord getPriceEnablerRecord(Type priceEnablerRecordType)
                                         throws OperationFailedException

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

Parameters:

priceEnablerRecordType - the type of price enabler record to retrieve

Returns:

the price enabler record

Throws:

NullArgumentException - priceEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.