Interface | osid.ordering.Price | ||
---|---|---|---|
Implements | osid.OsidRule | ||
osid.Subjugateable | |||
Description |
A | ||
Method | getPriceScheduleId | ||
Description |
Gets the price schedule | ||
Return | osid.id.Id | the price schedule Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriceSchedule | ||
Description |
Gets the price schedule to which this price belongs. | ||
Return | osid.ordering.PriceSchedule | the price schedule | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasQuantityRange | ||
Description |
Tests if this price is restricted by quantity. | ||
Return | boolean | true if this price has a quantity range, false
if this price is the same for any quantity | |
Compliance | mandatory | This method must be implemented. | |
Method | getMinimumQuantity | ||
Description |
Gets the minium quantity for this price. | ||
Return | cardinal | the quantity | |
Errors | ILLEGAL_STATE | hasQuantityRange() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getMaximumQuantity | ||
Description |
Gets the maximum quantity for this price. | ||
Return | cardinal | the quantity | |
Errors | ILLEGAL_STATE | hasQuantityRange() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasDemographic | ||
Description |
Tests if this price is restricted by demographic. | ||
Return | boolean | true if this price has a demographic, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicId | ||
Description |
Gets the resource | ||
Return | osid.id.Id | the resource Id | |
Errors | ILLEGAL_STATE | hasDemographic() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographic | ||
Description |
Gets the resource representing the demographic. | ||
Return | osid.resource.Resource | the resource | |
Errors | ILLEGAL_STATE | hasDemographic() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAmount | ||
Description |
Gets the amount. | ||
Return | osid.financials.Currency | the amount | |
Compliance | mandatory | This method must be implemented. | |
Method | isRecurring | ||
Description |
Tests if this price has a recurring charge. | ||
Return | boolean | true if this price is recurring, false if
one-time | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringInterval | ||
Description |
Gets the recurring interval. | ||
Return | osid.calendaring.Duration | the interval | |
Errors | ILLEGAL_STATE | isRecurring() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriceRecord | ||
Description |
Gets the price record corresponding to the given | ||
Parameters | osid.type.Type | priceRecordType | the type of price record to retrieve |
Return | osid.ordering.records.PriceRecord | the price record | |
Errors | NULL_ARGUMENT | priceRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(priceRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |