OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.Price
Implementsosid.OsidRule
osid.Subjugateable
Description

A Price.

MethodgetPriceScheduleId
Description

Gets the price schedule Id to which this price belongs.

Returnosid.id.Idthe price schedule Id
CompliancemandatoryThis method must be implemented.
MethodgetPriceSchedule
Description

Gets the price schedule to which this price belongs.

Returnosid.ordering.PriceSchedulethe price schedule
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasQuantityRange
Description

Tests if this price is restricted by quantity.

Returnboolean true if this price has a quantity range, false if this price is the same for any quantity
CompliancemandatoryThis method must be implemented.
MethodgetMinimumQuantity
Description

Gets the minium quantity for this price.

Returncardinalthe quantity
ErrorsILLEGAL_STATE hasQuantityRange() is false
CompliancemandatoryThis method must be implemented.
MethodgetMaximumQuantity
Description

Gets the maximum quantity for this price.

Returncardinalthe quantity
ErrorsILLEGAL_STATE hasQuantityRange() is false
CompliancemandatoryThis method must be implemented.
MethodhasDemographic
Description

Tests if this price is restricted by demographic.

Returnboolean true if this price has a demographic, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDemographicId
Description

Gets the resource Id representing the demographic.

Returnosid.id.Idthe resource Id
ErrorsILLEGAL_STATE hasDemographic() is false
CompliancemandatoryThis method must be implemented.
MethodgetDemographic
Description

Gets the resource representing the demographic.

Returnosid.resource.Resourcethe resource
ErrorsILLEGAL_STATE hasDemographic() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAmount
Description

Gets the amount.

Returnosid.financials.Currencythe amount
CompliancemandatoryThis method must be implemented.
MethodisRecurring
Description

Tests if this price has a recurring charge.

Returnboolean true if this price is recurring, false if one-time
CompliancemandatoryThis method must be implemented.
MethodgetRecurringInterval
Description

Gets the recurring interval.

Returnosid.calendaring.Durationthe interval
ErrorsILLEGAL_STATE isRecurring() is false
CompliancemandatoryThis method must be implemented.
MethodgetPriceRecord
Description

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

Parametersosid.type.TypepriceRecordTypethe type of price record to retrieve
Returnosid.ordering.records.PriceRecordthe price record
ErrorsNULL_ARGUMENT priceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceRecordType) is false
CompliancemandatoryThis method must be implemented.