OSID Logo
OSID Specifications
id batch package
Version 3.1.0
Interfaceosid.id.batch.IdBatchFormList
Implementsosid.OsidList
Used Byosid.id.batch.IdBatchAdminSession
Description

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

while (ibfl.hasNext()) {
     IdBatchForm form = ibfl.getNextIdBatchForm();
}
                
or
while (ibfl.hasNext()) {
     IdBatchForm[] forms = il.getNextIdBatchForms(ibfl.available());
}
                
MethodgetNextIdBatchForm
Description

Gets the next IdBatchForm in this list.

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

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

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