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

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

                     
                     
                     while (abbfl.hasNext()) {
                          AddressBookBatchForm form = abbfl.getNextAddressBookBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abbfl.hasNext()) {
                          AddressBookBatchForm[] forms = abbfl.getNextAddressBookBatchForms(abbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAddressBookBatchForm
Description

Gets the next AddressBookBatchForm in this list.

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

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

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