OSID Logo
OSID Specifications
repository batch package
Version 3.1.0
Interfaceosid.repository.batch.CompositionBatchFormList
Implementsosid.OsidList
Used Byosid.repository.batch.CompositionBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     CompositionBatchForm form = cbfl.getNextCompositionBatchForm();
}
                
or
while (cbfl.hasNext()) {
     CompositionBatchForm[] forms = cbfl.getNextCompositionBatchForms(cbfl.available());
}
                
MethodgetNextCompositionBatchForm
Description

Gets the next CompositionBatchForm in this list.

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

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

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