OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.PriceList
Implementsosid.OsidList
Used Byosid.ordering.Item
osid.ordering.PriceSchedule
osid.ordering.rules.PriceEnablerRuleLookupSession
Description

Like all OsidLists, PriceList provides a means for accessing Price elements sequentially either one at a time or many at a time. Examples:

while (pl.hasNext()) {
     Price price = pl.getNextPrice();
}
                
or
while (pl.hasNext()) {
     Price[] prices = pl.getNextPrices(pl.available());
}
                
MethodgetNextPrice
Description

Gets the next Price in this list.

Returnosid.ordering.Price the next Price in this list. The hasNext() method should be used to test that a next Price is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextPrices
Description

Gets the next set of Price elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Price elements requested which must be less than or equal to available()
Returnosid.ordering.Price[] an array of Price elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.