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