Class PensionContributionCalculatorFactory

Namespace

Payetools.Pensions

Assembly

Payetools.Pensions.dll

Factory to generate IPensionContributionCalculator implementations that are for a given pay date, pay frequency, earnings basis and tax treatment.

public class PensionContributionCalculatorFactory : IPensionContributionCalculatorFactory

Inheritance

object

PensionContributionCalculatorFactory

Implements

IPensionContributionCalculatorFactory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PensionContributionCalculatorFactory(IPensionsReferenceDataProvider)

Initialises a new instance of PensionContributionCalculatorFactory with the supplied reference data provider.

public PensionContributionCalculatorFactory(IPensionsReferenceDataProvider provider)

Parameters

provider IPensionsReferenceDataProvider

Reference data provider for pensions.

Methods

GetCalculator(PensionsEarningsBasis, PensionTaxTreatment, PayDate)

Gets a new IPensionContributionCalculator based on the specified pay date and number of tax periods. The pay date is provided in order to determine which set of thresholds (Qualifying Earnings only) and rates to use, noting that these may change in-year.

public IPensionContributionCalculator GetCalculator(PensionsEarningsBasis earningsBasis, PensionTaxTreatment taxTreatment, PayDate payDate)

Parameters

earningsBasis PensionsEarningsBasis

Earnings basis for pension calculation (Qualifying Earnings vs Pensionable Pay Set x.

taxTreatment PensionTaxTreatment

Tax treatment (net pay arrangement vs relief at source).

payDate PayDate

Applicable pay date.

Returns

IPensionContributionCalculator

A new calculator instance.

Exceptions

ArgumentException

Thrown if an unsupported earnings basis is provided.

GetCalculator(PensionsEarningsBasis, PensionTaxTreatment, TaxYear, PayFrequency, int)

Gets a new IPensionContributionCalculator based on the specified tax year, pay frequency and pay period, along with the applicable number of tax periods. The tax year, pay frequency and pay period are provided in order to determine which set of thresholds and rates to use, noting that these may (but rarely do) change in-year.

public IPensionContributionCalculator GetCalculator(PensionsEarningsBasis earningsBasis, PensionTaxTreatment taxTreatment, TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

earningsBasis PensionsEarningsBasis

Earnings basis for pension calculation (Qualifying Earnings vs Pensionable Pay Set x.

taxTreatment PensionTaxTreatment

Tax treatment (net pay arrangement vs relief at source).

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

IPensionContributionCalculator

A new calculator instance.

Exceptions

ArgumentException

Thrown if an unsupported earnings basis is provided.