OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.PriceScheduleList
Implementsosid.OsidList
Description

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

                     
                     
                     while (psl.hasNext()) {
                          PriceSchedule schedule = psl.getNextPriceSchedule();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (psl.hasNext()) {
                          PriceShedule[] schedules = psl.getNextPriceSchedules(psl.available());
                     }
                     
                                 
                     
                
MethodgetNextPriceSchedule
Description

Gets the next PriceSchedule in this list.

Returnosid.ordering.PriceSchedulethe next PriceSchedule in this list. The hasNext() method should be used to test that a next PriceSchedule is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPriceSchedules
Description

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

Parameterscardinalnthe number of PriceSchedule elements requested which must be less than or equal to available()
Returnosid.ordering.PriceSchedule[]an array of PriceSchedule elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.