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