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

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

                     
                     
                     while (bpl.hasNext()) {
                          BrokerProcessor processor = bpl.getNextBrokerProcessor();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bpl.hasNext()) {
                          BrokerProcessor[] processors = bpl.getNextBrokerProcessors(bpl.available());
                     }
                     
                                 
                     
                
MethodgetNextBrokerProcessor
Description

Gets the next BrokerProcessor in this list.

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

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

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