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

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

                     
                     
                     while (ocel.hasNext()) {
                          OfferingConstrainerEnabler enabler = ocel.getNextOfferingConstrainerEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ocel.hasNext()) {
                          OfferingConstrainerEnabler[] enablers = ocel.getNextOfferingConstrainerEnablers(ocel.available());
                     }
                     
                                 
                     
                
MethodgetNextOfferingConstrainerEnabler
Description

Gets the next OfferingConstrainerEnabler in this list.

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

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

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