Class StudentLoanCalculator

Namespace

Payetools.StudentLoans

Assembly

Payetools.StudentLoans.dll

Represents a student loan calculator that implements IStudentLoanCalculator.

public class StudentLoanCalculator : IStudentLoanCalculator

Inheritance

object

StudentLoanCalculator

Implements

IStudentLoanCalculator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StudentLoanCalculator(IStudentLoanThresholdSet, IStudentLoanRateSet)

Initialises a new instance of a StudentLoanCalculator with the supplied thresholds and rates. Note that supplied thresholds have been adjusted to correspond to the appropriate pay frequency for this calculator instance.

public StudentLoanCalculator(IStudentLoanThresholdSet thresholds, IStudentLoanRateSet rates)

Parameters

thresholds IStudentLoanThresholdSet

Thresholds adjusted to match pay frequency for this calculator.

rates IStudentLoanRateSet

Student and post-grad loan deduction rates.

Methods

Calculate(decimal, StudentLoanType?, bool, out IStudentLoanCalculationResult)

Calculates the necessary student loan deduction based on the input salary, the student loan type (if applicable) and indication of whether to apply post-graduate loan deductions.

public void Calculate(decimal grossSalary, StudentLoanType? studentLoanType, bool hasPostGradLoan, out IStudentLoanCalculationResult result)

Parameters

grossSalary decimal

Gross salary.

studentLoanType StudentLoanType?

Optional student loan type. Null if no student loan applies.

hasPostGradLoan bool

True if post-graduate loan deductions should be applied; false otherwise.

result IStudentLoanCalculationResult

An implementation of IStudentLoanCalculationResult containing the results of the calculation.