Module io.github.tonywasher.joceanus.moneywise.core

Package io.github.tonywasher.joceanus.moneywise.tax.uk

Class MoneyWiseUKTaxConfig

java.lang.Object

io.github.tonywasher.joceanus.moneywise.tax.uk.MoneyWiseUKTaxConfig

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem, io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxConfig, MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

public class MoneyWiseUKTaxConfig
extends Object
implements MetisFieldItem, MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Tax configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetCtl<T extends MetisFieldItem>, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MoneyWiseUKTaxConfig(MoneyWiseUKTax.MoneyWiseUKTaxYearCtl pTaxYear, io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxSource pTaxSource, OceanusDate pBirthday)	Constructor.

Method Summary

Modifier and Type	Method	Description
MoneyWiseUKTaxConfig	cloneIt()	Clone a current copy of the tax configuration.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
OceanusMoney	getAllowance()	Obtain the allowance.
OceanusDate	getBirthday()	Obtain the client birthday.
OceanusMoney	getCapitalAllowance()	Obtain the capital allowance.
Integer	getClientAge()	Obtain the client age.
MetisFieldSet<MoneyWiseUKTaxConfig>	getDataFieldSet()	Obtain the fieldSet.
OceanusMoney	getDividendAllowance()	Obtain the dividend allowance.
OceanusMoney	getGrossPreSavings()	Obtain the gross preSavings income.
OceanusMoney	getGrossTaxable()	Obtain the gross taxable income.
io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand	getLoSavingsBand()	Obtain the low savings band.
OceanusMoney	getRentalAllowance()	Obtain the rental allowance.
OceanusMoney	getSavingsAllowance()	Obtain the savings allowance.
io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet	getTaxBands()	Obtain the tax bands.
io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxSource	getTaxSource()	Obtain the tax bases.
MoneyWiseUKTax.MoneyWiseUKTaxYearCtl	getTaxYear()	Obtain the tax year.
boolean	hasAgeRelatedAllowance()	Do we have an age related allowance?
void	setHasAgeRelatedAllowance(boolean pFlag)	Set whether we have an age related allowance?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MoneyWiseUKTaxConfig

protected MoneyWiseUKTaxConfig(MoneyWiseUKTax.MoneyWiseUKTaxYearCtl pTaxYear,
 io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxSource pTaxSource,
 OceanusDate pBirthday)

Constructor.

Parameters:

pTaxYear - the taxYear

pTaxSource - the tax source

pBirthday - the client birthday

Method Details

getTaxYear

public MoneyWiseUKTax.MoneyWiseUKTaxYearCtl getTaxYear()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the tax year.

Specified by:

getTaxYear in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the tax year

getTaxSource

public io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxSource getTaxSource()

Obtain the tax bases.

Returns:

the bases

getGrossPreSavings

public OceanusMoney getGrossPreSavings()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the gross preSavings income.

Specified by:

getGrossPreSavings in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the gross preSavings

getGrossTaxable

public OceanusMoney getGrossTaxable()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the gross taxable income.

Specified by:

getGrossTaxable in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the gross taxable

getBirthday

public OceanusDate getBirthday()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the client birthday.

Specified by:

getBirthday in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the birthday

getClientAge

public Integer getClientAge()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the client age.

Specified by:

getClientAge in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the gross taxable

hasAgeRelatedAllowance

public boolean hasAgeRelatedAllowance()

Do we have an age related allowance?

Returns:

true/false

setHasAgeRelatedAllowance

public void setHasAgeRelatedAllowance(boolean pFlag)

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Set whether we have an age related allowance?

Specified by:

setHasAgeRelatedAllowance in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Parameters:

pFlag - true/false

getAllowance

public OceanusMoney getAllowance()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Obtain the allowance.

Specified by:

getAllowance in interface MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl

Returns:

the allowance

getRentalAllowance

public OceanusMoney getRentalAllowance()

Obtain the rental allowance.

Returns:

the rental allowance

getSavingsAllowance

public OceanusMoney getSavingsAllowance()

Obtain the savings allowance.

Returns:

the allowance

getDividendAllowance

public OceanusMoney getDividendAllowance()

Obtain the dividend allowance.

Returns:

the allowance

getCapitalAllowance

public OceanusMoney getCapitalAllowance()

Obtain the capital allowance.

Returns:

the allowance

getTaxBands

public io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet getTaxBands()

Obtain the tax bands.

Returns:

the tax bands

getLoSavingsBand

public io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand getLoSavingsBand()

Obtain the low savings band.

Returns:

the low savings band

getDataFieldSet

public MetisFieldSet<MoneyWiseUKTaxConfig> getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Returns:

the fieldSet

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

cloneIt

public MoneyWiseUKTaxConfig cloneIt()

Description copied from interface: io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxConfig

Clone a current copy of the tax configuration.

Specified by:

cloneIt in interface io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxConfig

Returns:

the cloned copy