org.osid.provisioning.rules

Interface PoolConstrainerList

All Superinterfaces:

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

public interface PoolConstrainerList
extends OsidList

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

       
       
       while (pcl.hasNext()) {
            PoolConstrainer constrainer = pcl.getNextPoolConstrainer();
       }
       
                   
       
  

or

       
       
       while (pcl.hasNext()) {
            PoolConstrainer[]constrainers = pcl.getNextPoolConstrainers(pcl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPoolConstrainer

PoolConstrainer getNextPoolConstrainer()
                                       throws OperationFailedException

Gets the next PoolConstrainer in this list.

Returns:

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

getNextPoolConstrainers

PoolConstrainer[] getNextPoolConstrainers(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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