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