OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.BrokerConstrainerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.BrokerConstrainerDistributorSession
osid.provisioning.rules.BrokerConstrainerEnablerRuleLookupSession
osid.provisioning.rules.BrokerConstrainerLookupSession
osid.provisioning.rules.BrokerConstrainerQuerySession
osid.provisioning.rules.BrokerConstrainerRuleLookupSession
osid.provisioning.rules.BrokerConstrainerSearchResults
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.BrokerConstrainer the next BrokerConstrainer in this list. The hasNext() method should be used to test that a next BrokerConstrainer is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.