OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.batch.FrontOfficeBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fbfl.hasNext()) {
                          FrontOfficeBatchForm form = fbfl.getNextFrontOfficeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          FrontOfficeBatchForm[] forms = fbfl.getNextFrontOfficeBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFrontOfficeBatchForm
Description

Gets the next FrontOfficeBatchForm in this list.

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

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

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