OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.BrokerEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.BrokerEnablerDistributorSession
osid.provisioning.rules.BrokerEnablerLookupSession
osid.provisioning.rules.BrokerEnablerQuerySession
osid.provisioning.rules.BrokerEnablerRuleLookupSession
osid.provisioning.rules.BrokerEnablerSearchResults
Description

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

while (bel.hasNext()) {
     BrokerEnabler enabler = bel.getNextBrokerEnabler();
}

or

while bel.hasNext()) {
     BrokerEnabler[] enablers = bel.getNextBrokerEnablers(bel.available());
}            
                
MethodgetNextBrokerEnabler
Description

Gets the next BrokerEnabler in this list.

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

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

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