org.osid.contact

Interface ContactList

All Superinterfaces:

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

public interface ContactList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Contact contact = cl.getNextContact();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Contact[] contacts = cl.getNextContacts(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Contact	getNextContact() Gets the next Contact in this list.
Contact[]	getNextContacts(long n) Gets the next set of Contact 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

getNextContact

Contact getNextContact()
                       throws OperationFailedException

Gets the next Contact in this list.

Returns:

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

getNextContacts

Contact[] getNextContacts(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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