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