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