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

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

                     
                     
                     while (bcel.hasNext()) {
                          BrokerConstrainerEnabler enabler = bcel.getNextBrokerConstrainerEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bcel.hasNext()) {
                          BrokerConstrainerEnabler[] enablers = bcel.getNextBrokerConstrainerEnablers(bcel.available());
                     }
                     
                                 
                     
                
MethodgetNextBrokerConstrainerEnabler
Description

Gets the next BrokerConstrainerEnabler in this list.

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

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

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