uk.ac.liv.auction.stats
Interface AuctionReport

All Superinterfaces:
AuctionEventListener
All Known Implementing Classes:
AbstractAuctionReport, CombiAuctionReport

public interface AuctionReport
extends AuctionEventListener

An object capable of producing a report at the end of an auction.

Version:
$Revision: 1.10 $
Author:
Steve Phelps

Method Summary
 java.util.Map getVariables()
          Returns a Map of all of the variables that are produced in the report.
 void produceUserOutput()
          Produce the final report for the user.
 void setAuction(RoundRobinAuction auction)
          Specify the auction to be used when generating the report.
 
Methods inherited from interface uk.ac.liv.auction.core.AuctionEventListener
eventOccurred
 

Method Detail

produceUserOutput

public void produceUserOutput()
Produce the final report for the user. Implementors can do whatever they see fit, for example by writing a report on stdout, or they may choose to do nothing.


getVariables

public java.util.Map getVariables()
Returns a Map of all of the variables that are produced in the report. The Map maps variables, represented by objects of type ReportVariable, onto values, which may be of any class. If no variables are produced by this report then an empty Map is returned.

See Also:
ReportVariable

setAuction

public void setAuction(RoundRobinAuction auction)
Specify the auction to be used when generating the report.