OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.CommissionBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cbfl.hasNext()) {
                          CommissionBatchForm form = cbfl.getNextCommissionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CommissionBatchForm[] forms = cbfl.getNextCommissionBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommissionBatchForm
Description

Gets the next CommissionBatchForm in this list.

Returnosid.resourcing.batch.CommissionBatchFormthe next CommissionBatchForm in this list. The hasNext() method should be used to test that a next CommissionBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextCommissionBatchForms
Description

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

Parameterscardinalnthe number of CommissionBatchForm elements requested which must be less than or equal to available()
Returnosid.resourcing.batch.CommissionBatchForm[]an array of CommissionBatchForm elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.