OSID Logo
OSID Specifications
workflow batch package
Version 3.1.0
Interfaceosid.workflow.batch.OfficeBatchFormList
Implementsosid.OsidList
Used Byosid.workflow.batch.OfficeBatchAdminSession
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.OfficeBatchForm the next OfficeBatchForm in this list. The hasNext() method should be used to test that a next OfficeBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.