OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (anl.hasNext()) {
                          AddressBookNode node = anl.getNextAddressBookNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (anl.hasNext()) {
                          AddressBookNode[] nodes = anl.getNextAddressBookNodes(anl.available());
                     }
                     
                                 
                     
                
MethodgetNextAddressBookNode
Description

Gets the next AddressBookNode in this list.

Returnosid.contact.AddressBookNodethe next AddressBookNode in this list. The hasNext() method should be used to test that a next AddressBookNode is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAddressBookNodes
Description

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

Parameterscardinalnthe number of AddressBookNode elements requested which must be less than or equal to available()
Returnosid.contact.AddressBookNode[]an array of AddressBookNode 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.