OSID Logo
OSID Specifications
offering batch package
Version 3.1.0
Interfaceosid.offering.batch.ParticipantBatchFormList
Implementsosid.OsidList
Used Byosid.offering.batch.ParticipantBatchAdminSession
Description

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

while (pobfl.hasNext()) {
     ParticipantBatchForm form = pobfl.getNextParticipantBatchForm();
}
                
or
while (pobfl.hasNext()) {
     ParticipantBatchForm[] forms = pobfl.getNextParticipantBatchForms(pobfl.available());
}
                
MethodgetNextParticipantBatchForm
Description

Gets the next ParticipantBatchForm in this list.

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

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

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