org.osid.provisioning

Interface BrokerList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface BrokerList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Broker broker = bl.getNextBroker();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Broker[] brokers = bl.getNextBrokers(bl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Broker	getNextBroker() Gets the next Broker in this list.
Broker[]	getNextBrokers(long n) Gets the next set of Broker elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextBroker

Broker getNextBroker()
                     throws OperationFailedException

Gets the next Broker in this list.

Returns:

the next Broker in this list. The hasNext() method should be used to test that a next Broker is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextBrokers

Broker[] getNextBrokers(long n)
                        throws OperationFailedException

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

Parameters:

n - the number of Broker elements requested which must be less than or equal to available()

Returns:

an array of Broker elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.