OSID Logo
OSID Specifications
lexicon batch package
Version 3.1.0
Interfaceosid.lexicon.batch.IdiomBatchFormList
Implementsosid.OsidList
Used Byosid.lexicon.batch.IdiomBatchAdminSession
Description

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

while (ibfl.hasNext()) {
     IdiomBatchForm form = ibfl.getNextIdiomBatchForm();
}

or

while (ibfl.hasNext()) {
                
    IdiomBatchForm[] forms = ibfl.getNextIdiomBatchForms(ibfl.available());
}
                
MethodgetNextIdiomBatchForm
Description

Gets the next IdiomBatchForm in this list.

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

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

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