OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionProcessorEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (apel.hasNext()) {
                          AuctionProcessorEnabler enabler = apel.getNextAuctionProcessorEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (apel.hasNext()) {
                          AuctionProcessorEnabler[] enablers = apel.getNextAuctionProcessorEnablers(apel.available());
                     }
                     
                                 
                     
                
MethodgetNextAuctionProcessorEnabler
Description

Gets the next AuctionProcessorEnabler in this list.

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

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

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