OSID Logo
OSID Specifications
workflow batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.batch.OfficeBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (obfl.hasNext()) {
                          OfficeBatchForm form = obfl.getNextOfficeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (obfl.hasNext()) {
                          OfficeBatchForm[] forms = obfl.getNextOfficeBatchForms(obfl.available());
                     }
                     
                                 
                     
                
MethodgetNextOfficeBatchForm
Description

Gets the next OfficeBatchForm in this list.

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

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

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