OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.BrokerProcessorList
Implementsosid.OsidList
Used Byosid.provisioning.rules.BrokerProcessorDistributorSession
osid.provisioning.rules.BrokerProcessorEnablerRuleLookupSession
osid.provisioning.rules.BrokerProcessorLookupSession
osid.provisioning.rules.BrokerProcessorQuerySession
osid.provisioning.rules.BrokerProcessorRuleLookupSession
osid.provisioning.rules.BrokerProcessorSearchResults
Description

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

while (bpl.hasNext()) {
     BrokerProcessor processor = bpl.getNextBrokerProcessor();
}

or

while (bpl.hasNext()) {
     BrokerProcessor[] processors = bpl.getNextBrokerProcessors(bpl.available());
}
                
MethodgetNextBrokerProcessor
Description

Gets the next BrokerProcessor in this list.

Returnosid.provisioning.rules.BrokerProcessor the next BrokerProcessor in this list. The hasNext() method should be used to test that a next BrokerProcessor 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.
MethodgetNextBrokerProcessors
Description

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

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