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