OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.OrderBatchFormList
Implementsosid.OsidList
Used Byosid.ordering.batch.OrderBatchAdminSession
Description

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

while (obfl.hasNext()) {
     OrderBatchForm form = obfl.getNextOrderBatchForm();
}
                
or
while (obfl.hasNext()) {
     OrderBatchForm[] forms = obfl.getNextOrderBatchForms(obfl.available());
}
                
MethodgetNextOrderBatchForm
Description

Gets the next OrderBatchForm in this list.

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

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

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