OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.PoolProcessorEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.PoolProcessorEnablerDistributorSession
osid.provisioning.rules.PoolProcessorEnablerLookupSession
osid.provisioning.rules.PoolProcessorEnablerQuerySession
osid.provisioning.rules.PoolProcessorEnablerRuleLookupSession
osid.provisioning.rules.PoolProcessorEnablerSearchResults
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.PoolProcessorEnabler the next PoolProcessorEnabler in this list. The hasNext() method should be used to test that a next PoolProcessorEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.