Package ch.sahits.game.openpatrician.model.city.guild

Interface IAuction

All Known Subinterfaces:

IBuildingAuction, IShipAuction

All Known Implementing Classes:

AbstractAuction, BuildingAuction, ShipAuction

public interface IAuction

Base model for the next auction hold in the guild.

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Nov 06, 2016

Method Summary

Modifier and Type	Method	Description
java.time.LocalDateTime	getAuctionDate()	Retrieve the date of the auction.
IPlayer	getBiddingPlayer()	Retrieve the currently bidding player.
java.util.List<IAIPlayer>	getBiddingPlayers()	Retrieve the list of AI players that can bid.
EBidLevel	getBidLevel()	Retrieve the current bid level.
int	getCurrentBid()	Retrieve the current bid of the bidding player.
ch.sahits.game.openpatrician.utilities.CancelableRunnable	getCurrentTask()	Retrieve the current task.
java.util.Optional<IPlayer>	getOwner()	Get the owner that is auctioning.
int	getStartingBid()	Retrieve the first bid amount.
void	setAuctionDate(java.time.LocalDateTime newDate)	Set the auction date.
void	setBiddingPlayer(IPlayer player)	Set the currently bidding player.
void	setBiddingPlayers(java.util.List<IAIPlayer> players)	Define the list of AI player that can bid.
void	setBidLevel(EBidLevel level)	Set the new bid level.
void	setCurrentBid(int bid)	Set the current bid.
void	setCurrentTask(ch.sahits.game.openpatrician.utilities.CancelableRunnable task)	Set the current task

Method Detail

getAuctionDate

java.time.LocalDateTime getAuctionDate()

Retrieve the date of the auction.

Returns:

date of the auction

setAuctionDate

void setAuctionDate(java.time.LocalDateTime newDate)

Set the auction date.

Parameters:

newDate - date of the action

getStartingBid

int getStartingBid()

Retrieve the first bid amount.

Returns:

initial bid of the auction

getOwner

java.util.Optional<IPlayer> getOwner()

Get the owner that is auctioning.

Returns:

if the auctioned item has an owner supply him

getBidLevel

EBidLevel getBidLevel()

Retrieve the current bid level.

Returns:

current bid level

setBidLevel

void setBidLevel(EBidLevel level)

Set the new bid level.

Parameters:

level - bid level

getBiddingPlayer

IPlayer getBiddingPlayer()

Retrieve the currently bidding player.

Returns:

player with the highest bid

setBiddingPlayer

void setBiddingPlayer(IPlayer player)

Set the currently bidding player.

Parameters:

player - player with the highest bid.

getCurrentBid

int getCurrentBid()

Retrieve the current bid of the bidding player.

Returns:

current bid

setCurrentBid

void setCurrentBid(int bid)

Set the current bid.

Parameters:

bid - current bid

getBiddingPlayers

java.util.List<IAIPlayer> getBiddingPlayers()

Retrieve the list of AI players that can bid.

Returns:

list of AIPlayers bidding

setBiddingPlayers

void setBiddingPlayers(java.util.List<IAIPlayer> players)

Define the list of AI player that can bid.

Parameters:

players - list of AIPlayers bidding

getCurrentTask

ch.sahits.game.openpatrician.utilities.CancelableRunnable getCurrentTask()

Retrieve the current task.

Returns:

task for the auction

setCurrentTask

void setCurrentTask(ch.sahits.game.openpatrician.utilities.CancelableRunnable task)

Set the current task

Parameters:

task - of the auction