org.osid.ordering

Interface PriceSchedule

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface PriceSchedule
extends OsidObject, Aggregateable

A PriceSchedule lists the price catalog.

Method Summary

Methods

Modifier and Type	Method and Description
IdList	getPriceIds() Gets the Ids of the prices.
PriceList	getPrices() Gets the prices.
PriceScheduleRecord	getPriceScheduleRecord(Type priceScheduleRecordType) Gets the price schedule record corresponding to the given PriceSchedule record Type.

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

Method Detail

getPriceIds

IdList getPriceIds()

Gets the Ids of the prices.

Returns:

the price Ids

Compliance:

mandatory - This method must be implemented.

getPrices

PriceList getPrices()
                    throws OperationFailedException

Gets the prices.

Returns:

the prices

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPriceScheduleRecord

PriceScheduleRecord getPriceScheduleRecord(Type priceScheduleRecordType)
                                           throws OperationFailedException

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 .

Parameters:

priceScheduleRecordType - the type of price schedule record to retrieve

Returns:

the price schedule record

Throws:

NullArgumentException - priceScheduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceScheduleRecordType) is false

Compliance:

mandatory - This method must be implemented.