OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolProcessorEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ppel.hasNext()) {
                          PoolProcessorEnabler enabler = ppel.getNextPoolProcessorEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppel.hasNext()) {
                          PoolProcessorEnabler[] enablers = ppel.getNextPoolProcessorEnablers(ppel.available());
                     }
                     
                                 
                     
                
MethodgetNextPoolProcessorEnabler
Description

Gets the next PoolProcessorEnabler in this list.

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

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

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