OSID Logo
OSID Specifications
ordering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.batch.StoreBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sbfl.hasNext()) {
                          StoreBatchForm form = sbfl.getNextStoreBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          StoreBatchForm[] forms = sbfl.getNextStoreBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextStoreBatchForm
Description

Gets the next StoreBatchForm in this list.

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

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

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