Interface DurationList

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

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

while (dl.hasNext()) {
     Duration duration = dl.getNextDuration();
}
or 
while dl.hasNext()) {
     Duration[] durations = dl.getNextDurations(dl.available());
}

Like all OsidLists, DurationList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextDuration

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

    • getNextDurations

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