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