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

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

                     
                     
                     while (pel.hasNext()) {
                          PriceEnabler enabler = pel.getNextPriceEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pel.hasNext()) {
                          PriceEnabler[] enablers = pel.getNextPriceEnablers(pel.available());
                     }
                     
                                 
                     
                
MethodgetNextPriceEnabler
Description

Gets the next PriceEnabler in this list.

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

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

Parameterscardinalnthe number of PriceEnabler elements requested which must be less than or equal to available()
Returnosid.ordering.rules.PriceEnabler[]an array of PriceEnabler 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.