org.osid.provisioning.batch

Interface ProvisionablePeerList

All Superinterfaces:

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

public interface ProvisionablePeerList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            ProvisionablePeer peer = ppl.getNextProvisionablePeer();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            ProvisionablePeer[] peers = ppl.getNextProvisionablePeers(ppl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProvisionablePeer

ProvisionablePeer getNextProvisionablePeer()
                                           throws OperationFailedException

Gets the next ProvisionablePeer in this list.

Returns:

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

getNextProvisionablePeers

ProvisionablePeer[] getNextProvisionablePeers(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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