org.osid.provisioning.batch

Interface ProvisionPeerList

All Superinterfaces:

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

public interface ProvisionPeerList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            ProvisionPeer peer = ppl.getNextProvisionPeer();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            ProvisionPeer[] peers = ppl.getNextProvisionPeers(ppl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ProvisionPeer	getNextProvisionPeer() Gets the next ProvisionPeer in this list.
ProvisionPeer[]	getNextProvisionPeers(long n) Gets the next set of ProvisionPeer 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

getNextProvisionPeer

ProvisionPeer getNextProvisionPeer()
                                   throws OperationFailedException

Gets the next ProvisionPeer in this list.

Returns:

the next ProvisionPeer in this list. The hasNext() method should be used to test that a next ProvisionPeer 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.

getNextProvisionPeers

ProvisionPeer[] getNextProvisionPeers(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

an array of ProvisionPeer 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.