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

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

Class MoneyWiseUKDividendScheme

java.lang.Object

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

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

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem

Direct Known Subclasses:

MoneyWiseUKDividendScheme.MoneyWiseUKDividendAsIncomeScheme, MoneyWiseUKDividendScheme.MoneyWiseUKDividendBaseRateScheme

public abstract class MoneyWiseUKDividendScheme
extends MoneyWiseUKIncomeScheme

Dividend Tax Scheme.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MoneyWiseUKDividendScheme.MoneyWiseUKDividendAdditionalRateScheme	Additional Rate Scheme.
static class	MoneyWiseUKDividendScheme.MoneyWiseUKDividendAsIncomeScheme	As Income Scheme.
static class	MoneyWiseUKDividendScheme.MoneyWiseUKDividendBaseRateScheme	Base Rate Scheme.
static class	MoneyWiseUKDividendScheme.MoneyWiseUKDividendHigherRateScheme	Higher Rate Scheme.
static class	MoneyWiseUKDividendScheme.MoneyWiseUKDividendLoHigherRateScheme	LoHigher Rate Scheme.

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

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MoneyWiseUKDividendScheme()	Constructor.
protected	MoneyWiseUKDividendScheme(Boolean pReliefAvailable)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected OceanusMoney	adjustAllowances(MoneyWiseUKTaxConfig pConfig, OceanusMoney pAmount)	Adjust Allowances.
protected OceanusRate	getAdditionalRate()	Obtain the additional rate.
protected OceanusMoney	getAmountInAllowance(MoneyWiseUKTaxConfig pConfig, OceanusMoney pAmount)	Obtain the taxFree amount.
protected OceanusRate	getBaseRate()	Obtain the base rate.
protected OceanusRate	getHigherRate()	Obtain the higher rate.
protected abstract OceanusRate	getTaxCreditRate(MoneyWiseUKTaxYear pTaxYear)	Obtain theTaxCredit rate for dividend.
protected Iterator<io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand>	taxBandIterator(MoneyWiseUKTaxConfig pConfig, io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxClass pBasis)	Obtain the taxBand iterator.

Methods inherited from class io.github.tonywasher.joceanus.moneywise.tax.uk.MoneyWiseUKIncomeScheme

adjustForAllowance, adjustTaxBands, allocateToTaxBands, formatObject, getAmountInBand, getDataFieldSet, taxReliefAvailable

Methods inherited from class java.lang.Object

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

Constructor Details

MoneyWiseUKDividendScheme

protected MoneyWiseUKDividendScheme()

Constructor.

MoneyWiseUKDividendScheme

protected MoneyWiseUKDividendScheme(Boolean pReliefAvailable)

Constructor.

Parameters:

pReliefAvailable - Is tax relief available?

Method Details

getTaxCreditRate

protected abstract OceanusRate getTaxCreditRate(MoneyWiseUKTaxYear pTaxYear)

Obtain theTaxCredit rate for dividend.

Parameters:

pTaxYear - the taxYear

Returns:

the taxCredit rate

adjustAllowances

protected OceanusMoney adjustAllowances(MoneyWiseUKTaxConfig pConfig,
 OceanusMoney pAmount)

Description copied from class: MoneyWiseUKIncomeScheme

Adjust Allowances.

Overrides:

adjustAllowances in class MoneyWiseUKIncomeScheme

Parameters:

pConfig - the taxConfig

pAmount - the amount that is to be adjusted

Returns:

the amount remaining

getAmountInAllowance

protected OceanusMoney getAmountInAllowance(MoneyWiseUKTaxConfig pConfig,
 OceanusMoney pAmount)

Description copied from class: MoneyWiseUKIncomeScheme

Obtain the taxFree amount.

Overrides:

getAmountInAllowance in class MoneyWiseUKIncomeScheme

Parameters:

pConfig - the taxConfig

pAmount - the amount that is to be adjusted

Returns:

the amount remaining

getBaseRate

protected OceanusRate getBaseRate()

Obtain the base rate.

Returns:

the base rate

getHigherRate

protected OceanusRate getHigherRate()

Obtain the higher rate.

Returns:

the higher rate

getAdditionalRate

protected OceanusRate getAdditionalRate()

Obtain the additional rate.

Returns:

the additional rate

taxBandIterator

protected Iterator<io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxBandSet.MoneyWiseTaxBand> taxBandIterator(MoneyWiseUKTaxConfig pConfig,
 io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxClass pBasis)

Description copied from class: MoneyWiseUKIncomeScheme

Obtain the taxBand iterator.

Overrides:

taxBandIterator in class MoneyWiseUKIncomeScheme

Parameters:

pConfig - the taxConfig

pBasis - the taxBasis

Returns:

the iterator