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

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

                     
                     
                     while (cupel.hasNext()) {
                          CanonicalUnitProcessorEnabler enabler = cupel.getNextCanonicalUnitProcessorEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cupel.hasNext()) {
                          CanonicalUnitProcessorEnabler[] enablers = cupel.getNextCanonicalUnitProcessorEnablers(cupel.available());
                     }
                     
                                 
                     
                
MethodgetNextCanonicalUnitProcessorEnabler
Description

Gets the next CanonicalUnitProcessorEnabler in this list.

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

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

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