public interface EventList extends OsidList
Like all OsidLists,
EventList
provides a
means for accessing Event
elements sequentially either one
at a time or many at a time. Examples:
while (el.hasNext()) { Event event = el.getNextEvent(); }or
while (el.hasNext()) { Event[] events = el.getNextEvents(el.available()); }
Modifier and Type | Method and Description |
---|---|
Event |
getNextEvent()
Gets the next
Event in this list. |
Event[] |
getNextEvents(long n)
Gets the next set of
Event elements in this list which
must be less than or equal to the number returned from
available(). |
Event getNextEvent() throws OperationFailedException
Event
in this list. Event
in this list. The
hasNext()
method should be used to test that a next
Event
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Event[] getNextEvents(long n) throws OperationFailedException
Event
elements in this list which
must be less than or equal to the number returned from
available().
n
- the number of Event
elements requested which
should be less than or equal to available()
Event
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.