Package com.planet_ink.coffee_mud.Common.interfaces

Interface AuctionData

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

DefaultAuction

public interface AuctionData
extends CMCommon

Class for storing basic data about a specific auction in progress. Handles both Live and Timed auction data.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
int	daysEllapsed(MOB mob, MOB mob2)	Returns the number of days ellapsed in this auction.
int	daysRemaining(MOB mob, MOB mob2)	Returns the number of days remaining in this auction.
java.lang.String	getAuctionDBKey()	Get the auction database key for this auction
Item	getAuctionedItem()	Get the item being auctioned.
MOB	getAuctioningMob()	Get the mob auctioning the item
int	getAuctionState()	Get the current auction State
long	getAuctionTickDown()	Get the tick down timer to check stuff
double	getBid()	Get the current bid in the auction
double	getBuyOutPrice()	Get the current buy-out price for this auction.
java.lang.String	getCurrency()	Get the currency the auction is being held in.
double	getHighBid()	Get the current high bid in the auction
MOB	getHighBidderMob()	Get the mob who is the high bidder in the auction.
long	getStartTime()	Get the start time of this auction
void	setAuctionDBKey(java.lang.String auctionDBKey)	Set the auction database key for this auction
void	setAuctionedItem(Item auctionedItem)	Set the item being auctioned.
void	setAuctioningMob(MOB auctioningM)	Set the mob auctioning the item
void	setAuctioningMobName(java.lang.String auctioningMName)	Set the mob auctioning the item
void	setAuctionState(int state)	Set the current auction State
void	setAuctionTickDown(long tickDown)	Set the tick down timer to check stuff
void	setBid(double bid)	Set the current bid in the auction
void	setBuyOutPrice(double buyOutPrice)	Set the current buy-out price for this auction.
void	setCurrency(java.lang.String currency)	Set the currency the auction is being held in.
void	setHighBid(double highBid)	Set the current high bid in the auction
void	setHighBidderMob(MOB highBidderM)	Set the mob who is the high bidder in the auction.
void	setHighBidderMobName(java.lang.String highBidderMName)	Set the mob name who is the high bidder in the auction.
void	setStartTime(long start)	Set the start time of this auction

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

daysRemaining

int daysRemaining(MOB mob,
                  MOB mob2)

Returns the number of days remaining in this auction. The mobs are only for determining which calendar to use. The first mobs' local calendar gets priority.

Parameters:

mob - the mob whose calendar to use

mob2 - the second mob whose calendar to use

Returns:

the number of days remaining in the auction

daysEllapsed

int daysEllapsed(MOB mob,
                 MOB mob2)

Returns the number of days ellapsed in this auction. The mobs are only for determining which calendar to use. The first mobs' local calendar gets priority.

Parameters:

mob - the mob whose calendar to use

mob2 - the second mob whose calendar to use

Returns:

the number of days ellapsed in the auction

getAuctionedItem

Item getAuctionedItem()

Get the item being auctioned.

Returns:

the item being auctioned.

See Also:

setAuctionedItem(Item)

setAuctionedItem

void setAuctionedItem(Item auctionedItem)

Set the item being auctioned.

Parameters:

auctionedItem - the item being auctioned.

See Also:

getAuctionedItem()

getAuctioningMob

MOB getAuctioningMob()

Get the mob auctioning the item

Returns:

the mob auctioning the item

See Also:

setAuctioningMob(MOB), setAuctioningMobName(String)

setAuctioningMob

void setAuctioningMob(MOB auctioningM)

Set the mob auctioning the item

Parameters:

auctioningM - the mob auctioning the item

See Also:

getAuctioningMob(), setAuctioningMobName(String)

setAuctioningMobName

void setAuctioningMobName(java.lang.String auctioningMName)

Set the mob auctioning the item

Parameters:

auctioningMName - the mob auctioning the item

See Also:

getAuctioningMob(), setAuctioningMob(MOB)

getHighBidderMob

MOB getHighBidderMob()

Get the mob who is the high bidder in the auction.

Returns:

the mob who is the high bidder in the auction.

See Also:

setHighBidderMob(MOB), setHighBidderMobName(String)

setHighBidderMob

void setHighBidderMob(MOB highBidderM)

Set the mob who is the high bidder in the auction.

Parameters:

highBidderM - the mob who is the high bidder in the auction.

See Also:

getHighBidderMob(), setHighBidderMobName(String)

setHighBidderMobName

void setHighBidderMobName(java.lang.String highBidderMName)

Set the mob name who is the high bidder in the auction.

Parameters:

highBidderMName - the mob who is the high bidder in the auction.

See Also:

getHighBidderMob(), setHighBidderMob(MOB)

getCurrency

java.lang.String getCurrency()

Get the currency the auction is being held in.

Returns:

the currency the auction is being held in.

See Also:

setCurrency(String)

setCurrency

void setCurrency(java.lang.String currency)

Set the currency the auction is being held in.

Parameters:

currency - the currency the auction is being held in.

See Also:

getCurrency()

getHighBid

double getHighBid()

Get the current high bid in the auction

Returns:

the current high bid in the auction

See Also:

setHighBid(double)

setHighBid

void setHighBid(double highBid)

Set the current high bid in the auction

Parameters:

highBid - the current high bid in the auction

See Also:

getHighBid()

getBid

double getBid()

Get the current bid in the auction

Returns:

the current bid in the auction

See Also:

setBid(double)

setBid

void setBid(double bid)

Set the current bid in the auction

Parameters:

bid - the current bid in the auction

See Also:

getBid()

getBuyOutPrice

double getBuyOutPrice()

Get the current buy-out price for this auction.

Returns:

the current buy-out price for this auction.

See Also:

setBuyOutPrice(double)

setBuyOutPrice

void setBuyOutPrice(double buyOutPrice)

Set the current buy-out price for this auction.

Parameters:

buyOutPrice - the current buy-out price for this auction.

See Also:

getBuyOutPrice()

getAuctionState

int getAuctionState()

Get the current auction State

Returns:

the current auction State

See Also:

setAuctionState(int)

setAuctionState

void setAuctionState(int state)

Set the current auction State

Parameters:

state - the current auction State

See Also:

getAuctionState()

getAuctionTickDown

long getAuctionTickDown()

Get the tick down timer to check stuff

Returns:

the tick down timer to check stuff

See Also:

setAuctionTickDown(long)

setAuctionTickDown

void setAuctionTickDown(long tickDown)

Set the tick down timer to check stuff

Parameters:

tickDown - the tick down timer to check stuff

See Also:

getAuctionTickDown()

getStartTime

long getStartTime()

Get the start time of this auction

Returns:

the start time of this auction

See Also:

setStartTime(long)

setStartTime

void setStartTime(long start)

Set the start time of this auction

Parameters:

start - the start time of this auction

See Also:

getStartTime()

getAuctionDBKey

java.lang.String getAuctionDBKey()

Get the auction database key for this auction

Returns:

the auction database key for this auction

See Also:

setAuctionDBKey(String)

setAuctionDBKey

void setAuctionDBKey(java.lang.String auctionDBKey)

Set the auction database key for this auction

Parameters:

auctionDBKey - the auction database key for this auction

See Also:

getAuctionDBKey()