OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.PoolEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.PoolEnablerDistributorSession
osid.provisioning.rules.PoolEnablerLookupSession
osid.provisioning.rules.PoolEnablerQuerySession
osid.provisioning.rules.PoolEnablerRuleLookupSession
osid.provisioning.rules.PoolEnablerSearchResults
Description

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

while (pel.hasNext()) {
     PoolEnabler enabler = pel.getNextPoolEnabler();
}

or

while (pel.hasNext()) {
     PoolEnabler[] enablers = pel.getNextPoolEnablers(pel.available());
}            
                
MethodgetNextPoolEnabler
Description

Gets the next PoolEnabler in this list.

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

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

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