OSID Logo
OSID Specifications
dictionary batch package
Version 3.1.0
Interfaceosid.dictionary.batch.DictionaryBatchFormList
Implementsosid.OsidList
Used Byosid.dictionary.batch.DictionaryBatchAdminSession
Description

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

while (dbfl.hasNext()) {
     DictionaryBatchForm form = dbfl.getNextDictionaryBatchForm();
}
                
or
while (dbfl.hasNext()) {
     DictionaryBatchForm[] forms = dbfl.getNextDictionaryBatchForms(dbfl.available());
}
                
MethodgetNextDictionaryBatchForm
Description

Gets the next DictionaryBatchForm in this list.

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

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

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