OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressBookList
Implementsosid.OsidList
Used Byosid.contact.AddressAddressBookSession
osid.contact.AddressBookHierarchySession
osid.contact.AddressBookLookupSession
osid.contact.AddressBookQuerySession
osid.contact.AddressBookSearchResults
osid.contact.ContactAddressBookSession
osid.contact.rules.ContactEnablerAddressBookSession
Description

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

Gets the next AddressBook in this list.

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

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

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