Interface PriceEnabler
- All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal
A PriceEnabler describes the rules for making a Price
effective.
-
Method Summary
Modifier and TypeMethodDescriptionlongGets the maximum quantity for this price.longGets the minium quantity for this price.getPriceEnablerRecord(Type priceEnablerRecordType) Gets the price enabler record corresponding to the givenPriceEnablerrecordType.booleanTests if this price is restricted by quantity.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface Operable
isActive, isDisabled, isEnabled, isOperationalModifier and TypeMethodDescriptionbooleanisActive()Tests if this operable is active.booleanTests if this operable is administravely disabled.booleanTests if this operable is administravely enabled.booleanTests if thisOperableis operational.Methods inherited from interface OsidEnabler
getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirementModifier and TypeMethodDescriptionGets the cyclic event.Gets the cyclic eventId.Gets the cyclic time period.Gets the cyclic time periodId.getEvent()Gets the event.Gets the eventId.Gets the schedule.Gets the scheduleId.Gets the time period.Gets the time periodId.booleanTests if the operational status of the enabler is governed by aCyclicEvent.booleanTests if this enabler is applied to a recurringCyclicTimePeriod.booleanTests if the operational status of the enabler is governed by anEvent.booleanTests if this enabler is applied to aTimePeriod.booleanTests if the operational status of the enabler is governed by aSchedule.booleanTests if thisOsidEnableris a requirement.Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.Methods inherited from interface OsidRule
getConditionRecordTypes, getRule, getRuleId, hasRuleMethods inherited from interface Temporal
getEndDate, getStartDate, isEffectiveModifier and TypeMethodDescriptionGets the end date.Gets the start date.booleanTests if the current date is within the start end end dates inclusive.
-
Method Details
-
hasQuantityRange
boolean hasQuantityRange()Tests if this price is restricted by quantity.- Returns:
trueif this price has a quantity range,falseif this price is the same for any quantity- Compliance:
mandatory- This method must be implemented.
-
getMinimumQuantity
long getMinimumQuantity()Gets the minium quantity for this price.- Returns:
- the quantity
- Throws:
IllegalStateException-hasQuantityRange()isfalse- Compliance:
mandatory- This method must be implemented.
-
getMaximumQuantity
long getMaximumQuantity()Gets the maximum quantity for this price.- Returns:
- the quantity
- Throws:
IllegalStateException-hasQuantityRange()isfalse- Compliance:
mandatory- This method must be implemented.
-
getPriceEnablerRecord
PriceEnablerRecord getPriceEnablerRecord(Type priceEnablerRecordType) throws OperationFailedException Gets the price enabler record corresponding to the givenPriceEnablerrecordType. This method is used to retrieve an object implementing the requested record. ThepriceEnablerRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(priceEnablerRecordType)istrue.- Parameters:
priceEnablerRecordType- the type of price enabler record to retrieve- Returns:
- the price enabler record
- Throws:
NullArgumentException-priceEnablerRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(priceEnablerRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-