Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface MoneyLibrary.DebtItem

Enclosing interface:

MoneyLibrary

public static interface MoneyLibrary.DebtItem

Interface for an object referencing a debt from one to another, denominated in base currency, and carrying a due date and interest rate.

Method Summary

Modifier and Type	Method	Description
double	amt()	The amount, in base currency value, that is currently owed.
java.lang.String	debtor()	Gets the name of the player that owes the money Some day this should be expanded to support the names of clans.
long	due()	The real-life due date of the loan, after which the collateral (property) is declared unowned.
double	interest()	Gets the percentage of the current amount due that is added back into the total every mud-month.
java.lang.String	owedTo()	Gets who the money is owed to, typically a bank chain name.
java.lang.String	reason()	Gets a short friendly description of the nature of the debt, usually something like "bank loan".
void	setAmt(double amt)	Alters the amount, in base currency value, that is currently owed.

Method Detail

debtor

java.lang.String debtor()

Gets the name of the player that owes the money Some day this should be expanded to support the names of clans.

Returns:

the name of the player that owes the money

owedTo

java.lang.String owedTo()

Gets who the money is owed to, typically a bank chain name.

Returns:

who the money is owed to

amt

double amt()

The amount, in base currency value, that is currently owed. All interest is included. The currency type comes from who it is owed to.

Returns:

The amount, in base currency value, owed

setAmt

void setAmt(double amt)

Alters the amount, in base currency value, that is currently owed. All interest is included. The currency type comes from who it is owed to.

Parameters:

amt - The amount, in base currency value, owed

due

long due()

The real-life due date of the loan, after which the collateral (property) is declared unowned.

Returns:

the real-life due date of the loan

interest

double interest()

Gets the percentage of the current amount due that is added back into the total every mud-month. The value is from 0-1.

Returns:

the percentage of the current amount due from 0-1

reason

java.lang.String reason()

Gets a short friendly description of the nature of the debt, usually something like "bank loan".

Returns:

a short friendly description of the nature of the debt