org.osid.contact

Interface AddressBookList

All Superinterfaces:

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

public interface AddressBookList
extends OsidList

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

       
       
       while (abl.hasNext()) {
            AddressBook book = abl.getNextAddressBook();
       }
       
                   
       
  

or

       
       
       while (abl.hasNext()) {
            AddressBook[] books = abl.getNextAddressBooks(abl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAddressBook

AddressBook getNextAddressBook()
                               throws OperationFailedException

Gets the next AddressBook in this list.

Returns:

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

getNextAddressBooks

AddressBook[] getNextAddressBooks(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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