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

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

                     
                     
                     while (pcel.hasNext()) {
                          PoolConstrainerEnabler enabler = pcel.getNextPoolConstrainerEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pcel.hasNext()) {
                          PoolConstrainerEnabler[] enablers = pcel.getNextPoolConstrainerEnablers(pcel.available());
                     }
                     
                                 
                     
                
MethodgetNextPoolConstrainerEnabler
Description

Gets the next PoolConstrainerEnabler in this list.

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

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

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