OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ocl.hasNext()) {
                          OfferingConstrainer = ocl.getNextOfferingConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ocl.hasNext()) {
                          OfferingConstrainer[] = ocel.getNextOfferingConstrainers(ocl.available());
                     }
                     
                                 
                     
                
MethodgetNextOfferingConstrainer
Description

Gets the next OfferingConstrainer in this list.

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

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

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