Interface RelationshipPeerList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

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());
}            
  

Method Summary

Modifier and Type	Method	Description
RelationshipPeer	getNextRelationshipPeer()	Gets the next RelationshipPeer in this list.
RelationshipPeer[]	getNextRelationshipPeers(long n)	Gets the next set of RelationshipPeer elements in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextRelationshipPeer

RelationshipPeer getNextRelationshipPeer()
                                  throws OperationFailedException

Gets the next RelationshipPeer in this list.

Returns:

the next RelationshipPeer in this list. The hasNext() method should be used to test that a next RelationshipPeer is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextRelationshipPeers

RelationshipPeer[] getNextRelationshipPeers(long n)
                                     throws OperationFailedException

Gets the next set of RelationshipPeer elements in this list. The specified amount must be less than or equal to the return from available() .

Parameters:

n - the number of RelationshipPeer elements requested which must be less than or equal to available()

Returns:

an array of RelationshipPeer elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.