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

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

                     
                     
                     while (bcl.hasNext()) {
                          BrokerConstrainer constrainer = bcl.getNextBrokerConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bcl.hasNext()) {
                          BrokerConstrainer[] constrainers = bcl.getNextBrokerConstrainers(bcl.available());
                     }
                     
                                 
                     
                
MethodgetNextBrokerConstrainer
Description

Gets the next BrokerConstrainer in this list.

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

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

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