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

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

                     
                     
                     while (pcl.hasNext()) {
                          PoolConstrainer constrainer = pcl.getNextPoolConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pcl.hasNext()) {
                          PoolConstrainer[]constrainers = pcl.getNextPoolConstrainers(pcl.available());
                     }
                     
                                 
                     
                
MethodgetNextPoolConstrainer
Description

Gets the next PoolConstrainer in this list.

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

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

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