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