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

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

                     
                     
                     while (qpl.hasNext()) {
                          QueueProcessor processor = qpl.getNextQueueProcessor();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (qpl.hasNext()) {
                          QueueProcessor[] processor = qpl.getNextQueueProcessors(qpl.available());
                     }
                     
                                 
                     
                
MethodgetNextQueueProcessor
Description

Gets the next QueueProcessor in this list.

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

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

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