com.palmergames.bukkit.towny.object

Class TownyEconomyObject

java.lang.Object

java.util.Observable

com.palmergames.bukkit.towny.object.TownyObject

com.palmergames.bukkit.towny.object.TownyEconomyObject

Direct Known Subclasses:

Nation, TownBlockOwner, WarSpoils

public class TownyEconomyObject
extends TownyObject

Economy object which provides an interface with the Economy Handler.

Author:

ElgarL, Shade

Constructor Summary

Constructors

Constructor and Description
TownyEconomyObject()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPayFromHoldings(double amount) Does this object have enough in it's economy account to pay?
boolean	collect(double amount, java.lang.String reason) When collecting money add it to the Accounts bank
java.lang.String	getEconomyName() Get a valid economy account name for this object.
double	getHoldingBalance()
java.lang.String	getHoldingFormattedBalance() Used To Get Balance of Players holdings in String format for printing
boolean	pay(double amount, java.lang.String reason) Tries to pay from the players holdings
boolean	payTo(double amount, TownyEconomyObject collector, java.lang.String reason) When one account is paying another account(Taxes/Plot Purchasing)
void	removeAccount() Attempt to delete the economy account.
boolean	setBalance(double amount, java.lang.String reason) Set balance and log this action

Methods inherited from class com.palmergames.bukkit.towny.object.TownyObject

getFormattedName, getName, getTreeDepth, getTreeString, getUID, isChangedName, setChangedName, setName, setUID, toString

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TownyEconomyObject

public TownyEconomyObject()

Method Detail

pay

public boolean pay(double amount,
          java.lang.String reason)
            throws EconomyException

Tries to pay from the players holdings

Parameters:

amount -

reason -

Returns:

true if successfull

Throws:

EconomyException

collect

public boolean collect(double amount,
              java.lang.String reason)
                throws EconomyException

When collecting money add it to the Accounts bank

Parameters:

amount -

reason -

Throws:

EconomyException

payTo

public boolean payTo(double amount,
            TownyEconomyObject collector,
            java.lang.String reason)
              throws EconomyException

When one account is paying another account(Taxes/Plot Purchasing)

Parameters:

amount -

collector -

reason -

Returns:

true if successfully payed amount to collector.

Throws:

EconomyException

getEconomyName

public java.lang.String getEconomyName()

Get a valid economy account name for this object.

Returns:

account name

setBalance

public boolean setBalance(double amount,
                 java.lang.String reason)
                   throws EconomyException

Set balance and log this action

Parameters:

amount -

reason -

Throws:

EconomyException

getHoldingBalance

public double getHoldingBalance()
                         throws EconomyException

Throws:

EconomyException

canPayFromHoldings

public boolean canPayFromHoldings(double amount)
                           throws EconomyException

Does this object have enough in it's economy account to pay?

Parameters:

amount -

Returns:

true if there is enough.

Throws:

EconomyException

getHoldingFormattedBalance

public java.lang.String getHoldingFormattedBalance()

Used To Get Balance of Players holdings in String format for printing

Returns:

current account balance formatted in a string.

removeAccount

public void removeAccount()

Attempt to delete the economy account.