OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.PoolProcessorList
Implementsosid.OsidList
Used Byosid.provisioning.rules.PoolProcessorDistributorSession
osid.provisioning.rules.PoolProcessorEnablerRuleLookupSession
osid.provisioning.rules.PoolProcessorLookupSession
osid.provisioning.rules.PoolProcessorQuerySession
osid.provisioning.rules.PoolProcessorRuleLookupSession
osid.provisioning.rules.PoolProcessorSearchResults
Description

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

while (ppl.hasNext()) {
     PoolProcessor processor = ppl.getNextPoolProcessor();
}
                
or
while (ppl.hasNext()) {
     PoolProcessor[] processors = ppl.getNextPoolProcessors(ppl.available());
}
                
MethodgetNextPoolProcessor
Description

Gets the next PoolProcessor in this list.

Returnosid.provisioning.rules.PoolProcessor the next PoolProcessor in this list. The hasNext() method should be used to test that a next PoolProcessor 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.
MethodgetNextPoolProcessors
Description

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

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