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