com.planet_ink.coffee_mud.Common.interfaces
Interface AuctionPolicy

All Superinterfaces:
java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>
All Known Subinterfaces:
Auctioneer
All Known Implementing Classes:
DefaultAuctionPolicy, GenAuctioneer, StdAuctioneer

public interface AuctionPolicy
extends CMCommon

Class for storing basic Auction House policies.


Method Summary
 double liveFinalCutPct()
          Gets the percent of an items final value to take off the winning bid for the house for a live auction.
 double liveListingPrice()
          Gets the flat fee in base currency to list an item of any sort at the auction house for a live auction.
 int maxTimedAuctionDays()
          Gets the maximum number of game-days that an auction can continue.
 void mergeAuctioneerPolicy(Auctioneer auction)
          Alters this policy to take account of the policies of the policies of a full timed auctioneer.
 int minTimedAuctionDays()
          Gets the minimum number of game-days that an auction can continue.
 void setLiveFinalCutPct(double d)
          Gets the percent of an items final value to take off the winning bid for the house.
 void setLiveListingPrice(double d)
          Sets the flat fee in base currency to list an item of any sort at the auction house for a live auction.
 void setMaxTimedAuctionDays(int d)
          Sets the maximum number of game-days that an auction can continue.
 void setMinTimedAuctionDays(int d)
          Sets the minimum number of game-days that an auction can continue.
 void setTimedFinalCutPct(double d)
          Gets the percent of an items final value to take off the winning bid for the house.
 void setTimedListingPct(double d)
          Sets the percent of an items value, per day, to charge to list an item.
 void setTimedListingPrice(double d)
          Sets the flat fee in base currency to list an item of any sort at the auction house for a timed auction.
 double timedFinalCutPct()
          Gets the percent of an items final value to take off the winning bid for the house for a timed auction.
 double timedListingPct()
          Gets the percent of an items value, per day, to charge to list an item.
 double timedListingPrice()
          Gets the flat fee in base currency to list an item of any sort at the auction house for a timed 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

timedListingPrice

double timedListingPrice()
Gets the flat fee in base currency to list an item of any sort at the auction house for a timed auction.

Returns:
the flat fee in base currency to list
See Also:
setTimedListingPrice(double)

setTimedListingPrice

void setTimedListingPrice(double d)
Sets the flat fee in base currency to list an item of any sort at the auction house for a timed auction.

Parameters:
d - the flat fee in base currency to list
See Also:
timedListingPrice()

timedListingPct

double timedListingPct()
Gets the percent of an items value, per day, to charge to list an item. 0.0-1.0 for a timed auction.

Returns:
the percent of an items value, per day
See Also:
setTimedListingPct(double)

setTimedListingPct

void setTimedListingPct(double d)
Sets the percent of an items value, per day, to charge to list an item. 0.0-1.0for a timed auction.

Parameters:
d - the percent of an items value, per day
See Also:
timedListingPct()

timedFinalCutPct

double timedFinalCutPct()
Gets the percent of an items final value to take off the winning bid for the house for a timed auction. 0.0-1.0

Returns:
the percent of an items final value
See Also:
setTimedFinalCutPct(double)

setTimedFinalCutPct

void setTimedFinalCutPct(double d)
Gets the percent of an items final value to take off the winning bid for the house. for a timed auction. 0.0-1.0

Parameters:
d - the percent of an items final value
See Also:
timedFinalCutPct()

maxTimedAuctionDays

int maxTimedAuctionDays()
Gets the maximum number of game-days that an auction can continue.

Returns:
the maximum number of game-days
See Also:
setMaxTimedAuctionDays(int)

setMaxTimedAuctionDays

void setMaxTimedAuctionDays(int d)
Sets the maximum number of game-days that an auction can continue.

Parameters:
d - the maximum number of game-days
See Also:
maxTimedAuctionDays()

minTimedAuctionDays

int minTimedAuctionDays()
Gets the minimum number of game-days that an auction can continue.

Returns:
the minimum number of game-days
See Also:
setMinTimedAuctionDays(int)

setMinTimedAuctionDays

void setMinTimedAuctionDays(int d)
Sets the minimum number of game-days that an auction can continue.

Parameters:
d - the minimum number of game-days
See Also:
minTimedAuctionDays()

liveListingPrice

double liveListingPrice()
Gets the flat fee in base currency to list an item of any sort at the auction house for a live auction.

Returns:
the flat fee in base currency to list
See Also:
setLiveListingPrice(double)

setLiveListingPrice

void setLiveListingPrice(double d)
Sets the flat fee in base currency to list an item of any sort at the auction house for a live auction.

Parameters:
d - the flat fee in base currency to list
See Also:
liveListingPrice()

liveFinalCutPct

double liveFinalCutPct()
Gets the percent of an items final value to take off the winning bid for the house for a live auction. 0.0-1.0

Returns:
the percent of an items final value
See Also:
setLiveFinalCutPct(double)

setLiveFinalCutPct

void setLiveFinalCutPct(double d)
Gets the percent of an items final value to take off the winning bid for the house. for a live auction. 0.0-1.0

Parameters:
d - the percent of an items final value
See Also:
liveFinalCutPct()

mergeAuctioneerPolicy

void mergeAuctioneerPolicy(Auctioneer auction)
Alters this policy to take account of the policies of the policies of a full timed auctioneer.

Parameters:
auction - the auctioneer
See Also:
Auctioneer