org.osid.contact

Interface AddressList

All Superinterfaces:

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

public interface AddressList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Address address = al.getNextAddress();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Address[] addresses = al.getNextAddresses(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAddress

Address getNextAddress()
                       throws OperationFailedException

Gets the next Address in this list.

Returns:

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

getNextAddresses

Address[] getNextAddresses(long n)
                           throws OperationFailedException

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

Parameters:

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

Returns:

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