OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Interfaceosid.bidding.rules.BidEnablerList
Implementsosid.OsidList
Used Byosid.bidding.rules.BidEnablerAuctionHouseSession
osid.bidding.rules.BidEnablerLookupSession
osid.bidding.rules.BidEnablerQuerySession
osid.bidding.rules.BidEnablerRuleLookupSession
osid.bidding.rules.BidEnablerSearchResults
Description

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

while (bel.hasNext()) {
     BidEnabler enabler = bel.getNextBidEnabler();
}

or

while (bel.hasNext()) {
     BidEnabler[] enablers = bel.getNextBidEnablers(bel.available());
}            
                
MethodgetNextBidEnabler
Description

Gets the next BidEnabler in this list.

Returnosid.bidding.rules.BidEnablerthe next BidEnabler in this list. The hasNext() method should be used to test that a next BidEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextBidEnablers
Description

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

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