OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressList
Implementsosid.OsidList
Used Byosid.contact.AddressAddressBookSession
osid.contact.AddressLookupSession
osid.contact.AddressQuerySession
osid.contact.AddressSearchResults
Description

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

Gets the next Address in this list.

Returnosid.contact.Address the next Address in this list. The hasNext() method should be used to test that a next Address is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextAddresses
Description

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

Parameterscardinaln the number of Address elements requested which must be less than or equal to available()
Returnosid.contact.Address[] an array of Address elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.