Interface ObstacleEnablerList

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

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

while (oel.hasNext()) {
     ObstacleEnabler enabler = oel.getNextObstacleEnabler();
}
or 
while (oel.hasNext()) {
     ObstacleEnabler[] enablers = oel.getNextObstacleEnablers(oel.available());
}

  • Method Details

    • getNextObstacleEnabler

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

    • getNextObstacleEnablers

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