org.osid.contact.batch

Interface ContactPeerList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface ContactPeerList
extends OsidList

Like all OsidLists, ContactPeerList provides a means for accessing ContactPeer elements sequentially either one at a time or many at a time. Examples:

       
       
       while (cpl.hasNext()) {
            ContactPeer peer = cpl.getNextContactPeer();
       }
       
                   
       
  

or

       
       
       while (cpl.hasNext()) {
            ContactPeer[] peers = cpl.getNextContactPeers(cpl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ContactPeer	getNextContactPeer() Gets the next ContactPeer in this list.
ContactPeer[]	getNextContactPeers(long n) Gets the next set of ContactPeer elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextContactPeer

ContactPeer getNextContactPeer()
                               throws OperationFailedException

Gets the next ContactPeer in this list.

Returns:

the next ContactPeer in this list. The hasNext() method should be used to test that a next ContactPeer 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.

getNextContactPeers

ContactPeer[] getNextContactPeers(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

an array of ContactPeer 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.