OSID Logo
OSID Specifications
inquiry batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.batch.AuditBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          AuditBatchForm form = abfl.getNextInquiryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AuditBatchForm[] forms = abfl.getNextAuditBatchForms(aibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuditBatchForm
Description

Gets the next AuditBatchForm in this list.

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

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

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