OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressList
Implementsosid.OsidList
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.Addressthe next Address in this list. The hasNext() method should be used to test that a next Address is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.