OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.OrderItemBatchFormList
Implementsosid.OsidList
Used Byosid.ordering.batch.OrderItemBatchAdminSession
Description

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

while (ibfl.hasNext()) {
     OrderItemBatchForm form = ibfl.getNextOrderItemBatchForm();
}
                
or
while (ibfl.hasNext()) {
     OrderItemBatchForm[] forms = ibfl.getNextOrderItemBatchForms(ibfl.available());
}
                

Like all OsidLists, OrderItemBatchFormList is stateful and must not be accessed by multiple processing threads.

MethodgetNextOrderItemBatchForm
Description

Gets the next OrderItemBatchForm in this list.

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

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

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