OSID Logo
OSID Specifications
contact batch package
Version 3.1.0
Interfaceosid.contact.batch.ContactBatchFormList
Implementsosid.OsidList
Used Byosid.contact.batch.ContactBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     ContactBatchForm form = cbfl.getNextContactBatchForm();
}
                
or
while (cbfl.hasNext()) {
     ContactBatchForm[] forms = cbfl.getNextContactBatchForms(cbfl.available());
}
                
MethodgetNextContactBatchForm
Description

Gets the next ContactBatchForm in this list.

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

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

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