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

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

                     
                     
                     while (cuel.hasNext()) {
                          CanonicalUnitEnabler enabler = cuel.getNextCanonicalUnitEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cuel.hasNext()) {
                          CanonicalUnitEnabler[] enablers = cuel.getNextCanonicalUnitEnablers(cuel.available());
                     }
                     
                                 
                     
                
MethodgetNextCanonicalUnitEnabler
Description

Gets the next CanonicalUnitEnabler in this list.

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

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

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