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