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