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