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