uk.ac.liv.auction.core
Interface Auction

All Superinterfaces:

QuoteProvider

All Known Implementing Classes:

AuctionImpl

public interface Auction

extends QuoteProvider

The interface used by agents to interact with an auction.

Version:

$Revision: 1.24 $

Author:

Steve Phelps

See Also:

AuctionImpl

Method Summary

void	clear(Shout ask, Shout bid, double price) Handle a single clearing operation between two traders
void	close() Close the auction.
boolean	closed() Returns true if the auction is closed.
Auctioneer	getAuctioneer() Return the current auctioneer for this auction.
int	getDay()
Shout	getLastShout() Return the last shout placed in the auction.
int	getNumberOfTraders() Get the number of traders known to be trading in the auction.
int	getRemainingTime() Get the remaining time in the current trading day (period).
AuctionReport	getReport(java.lang.Class reportClass)
int	getRound() Get the age of the auction in unspecified units
void	newShout(Shout shout) Place a new shout in the auction.
void	printState() Report the state of the auction.
void	removeShout(Shout shout) Remove a shout from the auction.
boolean	shoutAccepted(Shout shout) Find out whether the given shout has resulted in a transaction in the current round of trading.
boolean	transactionsOccured() Determine whether or not any transactions have occured in the current round of trading.

Methods inherited from interface uk.ac.liv.auction.core.QuoteProvider

getQuote

Method Detail

closed

public boolean closed()

Returns true if the auction is closed.

close

public void close()

Close the auction.

newShout

public void newShout(Shout shout)
              throws AuctionException

Place a new shout in the auction.

Throws:

AuctionException

removeShout

public void removeShout(Shout shout)

Remove a shout from the auction.

getLastShout

public Shout getLastShout()
                   throws ShoutsNotVisibleException

Return the last shout placed in the auction.

Throws:

ShoutsNotVisibleException

getAuctioneer

public Auctioneer getAuctioneer()

Return the current auctioneer for this auction.

printState

public void printState()

Report the state of the auction.

clear

public void clear(Shout ask,
                  Shout bid,
                  double price)

Handle a single clearing operation between two traders

getRound

public int getRound()

Get the age of the auction in unspecified units

getDay

public int getDay()

getRemainingTime

public int getRemainingTime()

Get the remaining time in the current trading day (period).

getNumberOfTraders

public int getNumberOfTraders()

Get the number of traders known to be trading in the auction.

shoutAccepted

public boolean shoutAccepted(Shout shout)
                      throws ShoutsNotVisibleException

Find out whether the given shout has resulted in a transaction in the current round of trading.

Throws:

ShoutsNotVisibleException

transactionsOccured

public boolean transactionsOccured()
                            throws ShoutsNotVisibleException

Determine whether or not any transactions have occured in the current round of trading.

Throws:

ShoutsNotVisibleException

getReport

public AuctionReport getReport(java.lang.Class reportClass)