OSID Logo
OSID Specifications
resourcing batch package
Version 3.1.0
Interfaceosid.resourcing.batch.CommissionBatchFormList
Implementsosid.OsidList
Used Byosid.resourcing.batch.CommissionBatchAdminSession
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.CommissionBatchForm the next CommissionBatchForm in this list. The hasNext() method should be used to test that a next CommissionBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.