Package ch.sahits.game.openpatrician.model

Interface ICompany

All Known Implementing Classes:

Company

public interface ICompany

The Company interface represents the company of a player and is mainly used to gather statistics

Author:

Andi Hotz, (c) Sahits GmbH, 2012 Created on Jul 24, 2012

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.LongProperty	cashProperty()	Retrieve the cash property.
long	getCash()	Retrieve the cash avalable to the company
long	getCompanyValue()	Retrieve the total value of the company
ICity	getHomeTown()	Retrieve the home town of the company
void	setCompanyValue(long newValue)	Set a new company value.
void	updateCash(long diff)	Add or subtract some cash
void	updateCashDirectly(long diff)	Add or subtract some cash directly.

Method Detail

getHomeTown

ICity getHomeTown()

Retrieve the home town of the company

Returns:

home town of the company

getCompanyValue

long getCompanyValue()

Retrieve the total value of the company

Returns:

value of the company

setCompanyValue

void setCompanyValue(long newValue)

Set a new company value.

Parameters:

newValue - new value replacing the old value

getCash

long getCash()

Retrieve the cash avalable to the company

Returns:

cash amount available

updateCashDirectly

void updateCashDirectly(long diff)

Add or subtract some cash directly. This method is intended for calls that do not originate in the UI.

Parameters:

diff - delta amount of cash to be updated

updateCash

void updateCash(long diff)

Add or subtract some cash

Parameters:

diff - amount of money that is transferred

cashProperty

javafx.beans.property.LongProperty cashProperty()

Retrieve the cash property.

Returns:

property