OSID Logo
OSID Specifications
bidding batch package
Version 3.1.0
Interfaceosid.bidding.batch.AuctionBatchFormList
Implementsosid.OsidList
Used Byosid.bidding.batch.AuctionBatchAdminSession
Description

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

while (abfl.hasNext()) {
     AuctionBatchForm form = abfl.getNextAuctionBatchForm();
}
                
or
while (abfl.hasNext()) {
     AuctionBatchForm[] forms = abfl.getNextAuctionBatchForms(abfl.available());
}
                
MethodgetNextAuctionBatchForm
Description

Gets the next AuctionBatchForm in this list.

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

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

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