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