org.osid.provisioning.rules

Interface PoolProcessorList

All Superinterfaces:

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

public interface PoolProcessorList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            PoolProcessor processor = ppl.getNextPoolProcessor();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            PoolProcessor[] processors = ppl.getNextPoolProcessors(ppl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPoolProcessor

PoolProcessor getNextPoolProcessor()
                                   throws OperationFailedException

Gets the next PoolProcessor in this list.

Returns:

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

getNextPoolProcessors

PoolProcessor[] getNextPoolProcessors(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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