OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.PriceSchedule
Implementsosid.OsidObject
osid.Aggregateable
Used Byosid.ordering.Cost
osid.ordering.Price
osid.ordering.PriceScheduleAdminSession
osid.ordering.PriceScheduleList
osid.ordering.PriceScheduleLookupSession
Description

A PriceSchedule lists the price catalog.

Like all OsidObjects, PriceSchedule is managed by its OsidSessions and may not be accessed by concurrent processing threads.

MethodhasListPrice
Description

Tests if this price schedule has a list price.

Returnboolean true if this price schedule has a list price, false otherwise
Compliancemandatory This method must be implemented.
MethodgetListPrice
Description

Gets the list price.

Returnosid.financials.Currency the list price
ErrorsILLEGAL_STATE hasListPrice() is false
Compliancemandatory This method must be implemented.
MethodisRecurring
Description

Tests if the list price has a recurring charge.

Returnboolean true if the list price is recurring, false if one-time
ErrorsILLEGAL_STATE hasListPrice() is false
Compliancemandatory This method must be implemented.
MethodgetRecurringInterval
Description

Gets the recurring interval of the list price.

Returnosid.calendaring.Duration the interval
ErrorsILLEGAL_STATE isRecurring() is false
Compliancemandatory This method must be implemented.
MethodgetPriceScheduleRecord
Description

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

Parametersosid.type.TypepriceScheduleRecordType the type of price schedule record to retrieve
Returnosid.ordering.records.PriceScheduleRecord the price schedule record
ErrorsNULL_ARGUMENT priceScheduleRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(priceScheduleRecordType) is false
Compliancemandatory This method must be implemented.