Interface PoolConstrainerEnablerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface PoolConstrainerEnablerList extends OsidList

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

while (pcel.hasNext()) {
     PoolConstrainerEnabler enabler = pcel.getNextPoolConstrainerEnabler();
}

or

while (pcel.hasNext()) {
     PoolConstrainerEnabler[] enablers = pcel.getNextPoolConstrainerEnablers(pcel.available());
}

  • Method Details

    • getNextPoolConstrainerEnabler

      PoolConstrainerEnabler getNextPoolConstrainerEnabler() throws OperationFailedException
      Gets the next PoolConstrainerEnabler in this list.
      Returns:
      the next PoolConstrainerEnabler in this list. The hasNext() method should be used to test that a next PoolConstrainerEnabler 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.

    • getNextPoolConstrainerEnablers

      PoolConstrainerEnabler[] getNextPoolConstrainerEnablers(long n) throws OperationFailedException
      Gets the next set of PoolConstrainerEnabler elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of PoolConstrainerEnabler elements requested which must be less than or equal to available()
      Returns:
      an array of PoolConstrainerEnabler 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.