OSID Logo
OSID Specifications
lexicon batch package
Version 3.1.0
Interfaceosid.lexicon.batch.PressBatchFormList
Implementsosid.OsidList
Used Byosid.lexicon.batch.PressBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     PressBatchForm form = pbfl.getNextPressBatchForm();
}

or

while (pbfl.hasNext()) {
                
PressBatchForm[] forms = pbfl.getNextPressBatchForms(pbfl.available());
}
                
MethodgetNextPressBatchForm
Description

Gets the next PressBatchForm in this list.

Returnosid.lexicon.batch.PressBatchForm the next PressBatchForm in this list. The hasNext() method should be used to test that a next PressBatchForm 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.
MethodgetNextPressBatchForms
Description

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

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