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