Class PayrunTestRunnerBase

Base class for file based payroll tests

Inheritance

object

TestRunnerBase

PayrunTestRunnerBase

PayrunEmployeePreviewTestRunner

PayrunEmployeeTestRunner

PayrunTestRunner

Inherited Members

TestRunnerBase.GetTenantAsync(string)

TestRunnerBase.DeleteTenantAsync(int)

TestRunnerBase.DeleteEmployeeAsync(int, int)

TestRunnerBase.GetUserAsync(int, string)

TestRunnerBase.GetEmployeeAsync(int, string)

TestRunnerBase.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client.Test.Payrun

Assembly: PayrollEngine.Client.Test.dll

Syntax

public abstract class PayrunTestRunnerBase : TestRunnerBase

Constructors

PayrunTestRunnerBase(PayrollHttpClient, PayrunTestSettings)

Initializes a new instance of the PayrunTestRunnerBase class

Declaration

protected PayrunTestRunnerBase(PayrollHttpClient httpClient, PayrunTestSettings settings)

Parameters

Type	Name	Description
PayrollHttpClient	httpClient	The payroll engine http client
PayrunTestSettings	settings	The test settings

Properties

Settings

The test settings

Declaration

protected PayrunTestSettings Settings { get; }

Property Value

Type	Description
PayrunTestSettings

TestPrecision

The testing precision

Declaration

protected TestPrecision TestPrecision { get; }

Property Value

Type	Description
TestPrecision

Methods

ApplyOwner(Exchange, string)

Apply the test owner

Declaration

protected virtual void ApplyOwner(Exchange exchange, string owner)

Parameters

Type	Name	Description
Exchange	exchange	The exchange
string	owner	The owner name

GetCollectorCustomResultsAsync(int, int, int)

Get collector custom results

Declaration

protected Task<List<CollectorCustomResult>> GetCollectorCustomResultsAsync(int tenantId, int payrollResultId, int collectorResultId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrollResultId	The payroll result id
int	collectorResultId	The collector result id

Returns

Type	Description
Task<List<CollectorCustomResult>>

GetCollectorResultsAsync(int, int)

Get collector results

Declaration

protected Task<List<CollectorResultSet>> GetCollectorResultsAsync(int tenantId, int payrollResultId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrollResultId	The payroll result id

Returns

Type	Description
Task<List<CollectorResultSet>>

GetEmployeePayrunJobsAsync(int, int)

Get employee payrun jobs

Declaration

protected Task<List<PayrunJob>> GetEmployeePayrunJobsAsync(int tenantId, int employeeId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	employeeId	The tenant identifier

Returns

Type	Description
Task<List<PayrunJob>>

GetPayrollResultAsync(int, int, int)

Get tenant

Declaration

protected Task<PayrollResult> GetPayrollResultAsync(int tenantId, int employeeId, int payrunJobId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	employeeId	The employee id
int	payrunJobId	The payrun job id

Returns

Type	Description
Task<PayrollResult>

GetPayrunJobAsync(int, int)

Get payrun job

Declaration

protected Task<PayrunJob> GetPayrunJobAsync(int tenantId, int payrunJobId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrunJobId	The payrun job id

Returns

Type	Description
Task<PayrunJob>

GetPayrunJobsAsync(int, string)

Get payrun jobs

Declaration

protected Task<List<PayrunJob>> GetPayrunJobsAsync(int tenantId, string payrunName)

Parameters

Type	Name	Description
int	tenantId	The tenant id
string	payrunName	The payrun name

Returns

Type	Description
Task<List<PayrunJob>>

GetPayrunResultsAsync(int, int)

Get payrun results

Declaration

protected Task<List<PayrunResult>> GetPayrunResultsAsync(int tenantId, int payrollResultId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrollResultId	The payroll result id

Returns

Type	Description
Task<List<PayrunResult>>

GetWageTypeCustomResultsAsync(int, int, int)

Get wage type custom results

Declaration

protected Task<List<WageTypeCustomResult>> GetWageTypeCustomResultsAsync(int tenantId, int payrollResultId, int wageTypeResultId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrollResultId	The payroll result id
int	wageTypeResultId	The wage type result id

Returns

Type	Description
Task<List<WageTypeCustomResult>>

GetWageTypeResultsAsync(int, int)

Get wage type results

Declaration

protected Task<List<WageTypeResultSet>> GetWageTypeResultsAsync(int tenantId, int payrollResultId)

Parameters

Type	Name	Description
int	tenantId	The tenant id
int	payrollResultId	The payroll result id

Returns

Type	Description
Task<List<WageTypeResultSet>>

TestAllAsync(Exchange)

Start the test

Declaration

public abstract Task<Dictionary<Tenant, List<PayrollTestResult>>> TestAllAsync(Exchange exchange)

Parameters

Type	Name	Description
Exchange	exchange	The test exchange

Returns

Type	Description
Task<Dictionary<Tenant, List<PayrollTestResult>>>	A list of payrun job results

TestPayrunJobAsync(ExchangeTenant, JobResultMode)

Tests the payrun job

Declaration

protected virtual Task<IList<PayrollTestResult>> TestPayrunJobAsync(ExchangeTenant tenant, JobResultMode jobResultMode)

Parameters

Type	Name	Description
ExchangeTenant	tenant	The tenant
JobResultMode	jobResultMode	The job result mode

Returns

Type	Description
Task<IList<PayrollTestResult>>	List of payrun job test results

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)

ValueTypeExtensions.GetValueType(object)

ObjectInfo.GetPropertyValue(object, string)

ObjectInfo.GetPropertyValue<T>(object, string, T)

ObjectInfo.ResolvePropertyValue(object, string)

ObjectInfo.SetPropertyValue(object, string, object)