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

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

                     
                     
                     while (bl.hasNext()) {
                          Broker broker = bl.getNextBroker();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Broker[] brokers = bl.getNextBrokers(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBroker
Description

Gets the next Broker in this list.

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

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

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