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