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

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

Class MoneyWiseUKBasicAllowance

java.lang.Object

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

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem, MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Direct Known Subclasses:

MoneyWiseUKAgeAllowance, MoneyWiseUKSavingsAllowance

public abstract class MoneyWiseUKBasicAllowance
extends Object
implements MetisFieldItem, MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Basic UK Tax Allowance.

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	MoneyWiseUKBasicAllowance(OceanusMoney pAllowance, OceanusMoney pRentalAllowance, OceanusMoney pCapitalAllowance)	Constructor.
protected	MoneyWiseUKBasicAllowance(OceanusMoney pAllowance, OceanusMoney pRentalAllowance, OceanusMoney pCapitalAllowance, io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseMarginalReduction pReduction)	Constructor.

Method Summary

Modifier and Type	Method	Description
OceanusMoney	calculateBasicAllowance(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig)	Calculate the allowance.
OceanusMoney	calculateDividendAllowance()	Calculate the dividend allowance.
io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand	calculateLoSavingsBand(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig, io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand pLoSavings)	Calculate the loSavings band.
OceanusMoney	calculateSavingsAllowance(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig)	Calculate the savings allowance.
OceanusMoney	getAllowance()	Obtain the allowance.
protected static MetisFieldSet<? extends MoneyWiseUKBasicAllowance>	getBaseFieldSet()	Obtain the data fields.
OceanusMoney	getCapitalAllowance()	Obtain the capital allowance.
protected io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseMarginalReduction	getMarginalReduction()	Obtain the marginal reduction.
OceanusMoney	getRentalAllowance()	Obtain the rental allowance.
protected OceanusMoney	getZeroAmount()	Obtain zero amount.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataObjectFormat

formatObject

Methods inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

getDataFieldSet

Constructor Details

MoneyWiseUKBasicAllowance

protected MoneyWiseUKBasicAllowance(OceanusMoney pAllowance,
 OceanusMoney pRentalAllowance,
 OceanusMoney pCapitalAllowance,
 io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseMarginalReduction pReduction)

Constructor.

Parameters:

pAllowance - the allowance

pRentalAllowance - the rental allowance

pCapitalAllowance - the capital allowance

pReduction - the marginal reduction

MoneyWiseUKBasicAllowance

protected MoneyWiseUKBasicAllowance(OceanusMoney pAllowance,
 OceanusMoney pRentalAllowance,
 OceanusMoney pCapitalAllowance)

Constructor.

Parameters:

pAllowance - the allowance

pRentalAllowance - the rental allowance

pCapitalAllowance - the capital allowance

Method Details

getAllowance

public OceanusMoney getAllowance()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Obtain the allowance.

Specified by:

getAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Returns:

the Allowance

getRentalAllowance

public OceanusMoney getRentalAllowance()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Obtain the rental allowance.

Specified by:

getRentalAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Returns:

the Allowance

getCapitalAllowance

public OceanusMoney getCapitalAllowance()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Obtain the capital allowance.

Specified by:

getCapitalAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Returns:

the Allowance

getMarginalReduction

protected io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseMarginalReduction getMarginalReduction()

Obtain the marginal reduction.

Returns:

the Reduction

calculateBasicAllowance

public OceanusMoney calculateBasicAllowance(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig)

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Calculate the allowance.

Specified by:

calculateBasicAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Parameters:

pConfig - the tax configuration

Returns:

the calculated allowance

calculateSavingsAllowance

public OceanusMoney calculateSavingsAllowance(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig)

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Calculate the savings allowance.

Specified by:

calculateSavingsAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Parameters:

pConfig - the tax configuration

Returns:

the savings allowance

calculateDividendAllowance

public OceanusMoney calculateDividendAllowance()

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Calculate the dividend allowance.

Specified by:

calculateDividendAllowance in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Returns:

the dividend allowance

calculateLoSavingsBand

public io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand calculateLoSavingsBand(MoneyWiseUKTax.MoneyWiseUKTaxConfigCtl pConfig,
 io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand pLoSavings)

Description copied from interface: MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Calculate the loSavings band.

Specified by:

calculateLoSavingsBand in interface MoneyWiseUKTax.MoneyWiseUKBasicAllowanceCtl

Parameters:

pConfig - the tax configuration

pLoSavings - the low savings band

Returns:

the loSavings band

getZeroAmount

protected OceanusMoney getZeroAmount()

Obtain zero amount.

Returns:

the zero amount

getBaseFieldSet

protected static MetisFieldSet<? extends MoneyWiseUKBasicAllowance> getBaseFieldSet()

Obtain the data fields.

Returns:

the data fields