OSID Logo
OSID Specifications
recipe batch package
Version 3.1.0
Interfaceosid.recipe.batch.DirectionBatchFormList
Implementsosid.OsidList
Used Byosid.recipe.batch.DirectionBatchAdminSession
Description

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

while (dbfl.hasNext()) {
     DirectionBatchForm form = dbfl.getNextDirectionBatchForm();
}
                
or
while (dbfl.hasNext()) {
     DirectionBatchForm[] forms = dbfl.getNextDirectionBatchForms(dbfl.available());
}
                
MethodgetNextDirectionBatchForm
Description

Gets the next DirectionBatchForm in this list.

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

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

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