OSID Logo
OSID Specifications
mapping path batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.batch.SignalBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sbfl.hasNext()) {
                          SignalBatchForm form = sbfl.getNextSignalBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SignalBatchForm[] forms = sbfl.getNextSignalBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSignalBatchForm
Description

Gets the next SignalBatchForm in this list.

Returnosid.mapping.path.batch.SignalBatchFormthe next SignalBatchForm in this list. The hasNext() method should be used to test that a next SignalBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextSignalBatchForms
Description

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

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