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