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