com.planet_ink.coffee_mud.Common
Class DefaultAuctionPolicy

java.lang.Object
  extended by com.planet_ink.coffee_mud.Common.DefaultAuctionPolicy
All Implemented Interfaces:
AuctionPolicy, CMCommon, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultAuctionPolicy
extends java.lang.Object
implements AuctionPolicy, java.lang.Cloneable


Constructor Summary
DefaultAuctionPolicy()
           
 
Method Summary
 int compareTo(CMObject o)
           
 CMObject copyOf()
          Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 void initializeClass()
          Called ONCE after all objects are loaded, but before the map is read in during initialization.
 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 A)
          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.
 java.lang.String name()
          The displayable name of this object.
 CMObject newInstance()
          Returns a new instance of this class.
 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultAuctionPolicy

public DefaultAuctionPolicy()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Returns:
the name of this class

name

public java.lang.String name()
Description copied from interface: CMObject
The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:
name in interface CMObject
Returns:
the modified final name of this object on the map.
See Also:
Environmental.Name()

compareTo

public int compareTo(CMObject o)
Specified by:
compareTo in interface java.lang.Comparable<CMObject>

newInstance

public CMObject newInstance()
Description copied from interface: CMObject
Returns a new instance of this class.

Specified by:
newInstance in interface CMObject
Returns:
a new instance of this class

copyOf

public CMObject copyOf()
Description copied from interface: CMObject
Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:
copyOf in interface CMObject
Returns:
a clone of this object

initializeClass

public void initializeClass()
Description copied from interface: CMObject
Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:
initializeClass in interface CMObject

mergeAuctioneerPolicy

public void mergeAuctioneerPolicy(Auctioneer A)
Description copied from interface: AuctionPolicy
Alters this policy to take account of the policies of the policies of a full timed auctioneer.

Specified by:
mergeAuctioneerPolicy in interface AuctionPolicy
Parameters:
A - the auctioneer
See Also:
Auctioneer

timedListingPrice

public double timedListingPrice()
Description copied from interface: AuctionPolicy
Gets the flat fee in base currency to list an item of any sort at the auction house for a timed auction.

Specified by:
timedListingPrice in interface AuctionPolicy
Returns:
the flat fee in base currency to list
See Also:
AuctionPolicy.setTimedListingPrice(double)

setTimedListingPrice

public void setTimedListingPrice(double d)
Description copied from interface: AuctionPolicy
Sets the flat fee in base currency to list an item of any sort at the auction house for a timed auction.

Specified by:
setTimedListingPrice in interface AuctionPolicy
Parameters:
d - the flat fee in base currency to list
See Also:
AuctionPolicy.timedListingPrice()

timedListingPct

public double timedListingPct()
Description copied from interface: AuctionPolicy
Gets the percent of an items value, per day, to charge to list an item. 0.0-1.0 for a timed auction.

Specified by:
timedListingPct in interface AuctionPolicy
Returns:
the percent of an items value, per day
See Also:
AuctionPolicy.setTimedListingPct(double)

setTimedListingPct

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

Specified by:
setTimedListingPct in interface AuctionPolicy
Parameters:
d - the percent of an items value, per day
See Also:
AuctionPolicy.timedListingPct()

timedFinalCutPct

public double timedFinalCutPct()
Description copied from interface: AuctionPolicy
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

Specified by:
timedFinalCutPct in interface AuctionPolicy
Returns:
the percent of an items final value
See Also:
AuctionPolicy.setTimedFinalCutPct(double)

setTimedFinalCutPct

public void setTimedFinalCutPct(double d)
Description copied from interface: AuctionPolicy
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

Specified by:
setTimedFinalCutPct in interface AuctionPolicy
Parameters:
d - the percent of an items final value
See Also:
AuctionPolicy.timedFinalCutPct()

maxTimedAuctionDays

public int maxTimedAuctionDays()
Description copied from interface: AuctionPolicy
Gets the maximum number of game-days that an auction can continue.

Specified by:
maxTimedAuctionDays in interface AuctionPolicy
Returns:
the maximum number of game-days
See Also:
AuctionPolicy.setMaxTimedAuctionDays(int)

setMaxTimedAuctionDays

public void setMaxTimedAuctionDays(int d)
Description copied from interface: AuctionPolicy
Sets the maximum number of game-days that an auction can continue.

Specified by:
setMaxTimedAuctionDays in interface AuctionPolicy
Parameters:
d - the maximum number of game-days
See Also:
AuctionPolicy.maxTimedAuctionDays()

minTimedAuctionDays

public int minTimedAuctionDays()
Description copied from interface: AuctionPolicy
Gets the minimum number of game-days that an auction can continue.

Specified by:
minTimedAuctionDays in interface AuctionPolicy
Returns:
the minimum number of game-days
See Also:
AuctionPolicy.setMinTimedAuctionDays(int)

setMinTimedAuctionDays

public void setMinTimedAuctionDays(int d)
Description copied from interface: AuctionPolicy
Sets the minimum number of game-days that an auction can continue.

Specified by:
setMinTimedAuctionDays in interface AuctionPolicy
Parameters:
d - the minimum number of game-days
See Also:
AuctionPolicy.minTimedAuctionDays()

liveListingPrice

public double liveListingPrice()
Description copied from interface: AuctionPolicy
Gets the flat fee in base currency to list an item of any sort at the auction house for a live auction.

Specified by:
liveListingPrice in interface AuctionPolicy
Returns:
the flat fee in base currency to list
See Also:
AuctionPolicy.setLiveListingPrice(double)

setLiveListingPrice

public void setLiveListingPrice(double d)
Description copied from interface: AuctionPolicy
Sets the flat fee in base currency to list an item of any sort at the auction house for a live auction.

Specified by:
setLiveListingPrice in interface AuctionPolicy
Parameters:
d - the flat fee in base currency to list
See Also:
AuctionPolicy.liveListingPrice()

liveFinalCutPct

public double liveFinalCutPct()
Description copied from interface: AuctionPolicy
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

Specified by:
liveFinalCutPct in interface AuctionPolicy
Returns:
the percent of an items final value
See Also:
AuctionPolicy.setLiveFinalCutPct(double)

setLiveFinalCutPct

public void setLiveFinalCutPct(double d)
Description copied from interface: AuctionPolicy
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

Specified by:
setLiveFinalCutPct in interface AuctionPolicy
Parameters:
d - the percent of an items final value
See Also:
AuctionPolicy.liveFinalCutPct()