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