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

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

                     
                     
                     while (pl.hasNext()) {
                          Pool pool = pl.getNextPool();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Pool[] pools = pl.getNextPools(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPool
Description

Gets the next Pool in this list.

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

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

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