OSID Logo
OSID Specifications
subscription batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.batch.DispatchBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dbfl.hasNext()) {
                          DispatchBatchForm form = dbfl.getNextDispatchBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dbfl.hasNext()) {
                          DispatchBatchForm[] forms = dbfl.getNextDispatchBatchForms(dbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextDispatchBatchForm
Description

Gets the next DispatchBatchForm in this list.

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

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

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