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

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

                     
                     
                     while (qbfl.hasNext()) {
                          QueueBatchForm form = qbfl.getNextQueueBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (qbfl.hasNext()) {
                          QueueBatchForm[] forms = qbfl.getNextQueueBatchForms(qbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextQueueBatchForm
Description

Gets the next QueueBatchForm in this list.

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

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

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