OSID Logo
OSID Specifications
control batch package
Version 3.1.0
Interfaceosid.control.batch.SceneBatchFormList
Implementsosid.OsidList
Used Byosid.control.batch.SceneBatchAdminSession
Description

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

while (sbfl.hasNext()) {
     SceneBatchForm form = sbfl.getNextSceneBatchForm();
}
                
or
while (sbfl.hasNext()) {
     SceneBatchForm[] forms = sbfl.getNextSceneBatchForms(sbfl.available());
}
                
MethodgetNextSceneBatchForm
Description

Gets the next SceneBatchForm in this list.

Returnosid.control.batch.SceneBatchForm the next SceneBatchForm in this list. The hasNext() method should be used to test that a next SceneBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextSceneBatchForms
Description

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

Parameterscardinaln the number of SceneBatchForm elements requested which must be less than or equal to available()
Returnosid.control.batch.SceneBatchForm[] an array of SceneBatchForm elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.