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