Interface PoolConstrainerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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 Details

    • 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.