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

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

                     
                     
                     while (abfl.hasNext()) {
                          AddressBatchForm form = abfl.getNextAddressBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AddressBatchForm[] forms = abfl.getNextAddressBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAddressBatchForm
Description

Gets the next AddressBatchForm in this list.

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

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

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