OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.IssueBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ibfl.hasNext()) {
                          IssueBatchForm form = ibfl.getNextIssueBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          IssueBatchForm[] forms = ibfl.getNextIssueBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextIssueBatchForm
Description

Gets the next IssueBatchForm in this list.

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

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

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