Show / Hide Table of Contents

Class ExchangeImport

Import exchange from JSON file to Payroll API

Inheritance
object
VisitorBase
Visitor
AttachmentsLoader
ExchangeImportVisitor
ExchangeImport
Inherited Members
ExchangeImportVisitor.ImportOptions
ExchangeImportVisitor.HttpClient
AttachmentsLoader.Read()
AttachmentsLoader.ReadAsync()
Visitor.Execute()
Visitor.ExecuteAsync()
Visitor.VisitExchangeTenant
Visitor.VisitRegulationShare
Visitor.VisitUser
Visitor.VisitDivision
Visitor.VisitTask
Visitor.VisitWebhook
Visitor.VisitRegulation
Visitor.VisitLookup
Visitor.VisitLookupValue
Visitor.VisitCase
Visitor.VisitCaseField
Visitor.VisitCaseRelation
Visitor.VisitCollector
Visitor.VisitWageType
Visitor.VisitScript
Visitor.VisitReport
Visitor.VisitReportParameter
Visitor.VisitReportTemplate
Visitor.VisitEmployee
Visitor.VisitPayroll
Visitor.VisitPayrollLayer
Visitor.VisitCaseChangeSetup
Visitor.VisitCaseSetup
Visitor.VisitCaseValue
Visitor.VisitPayrun
Visitor.VisitPayrunParameter
Visitor.VisitPayrunJobInvocation
Visitor.VisitPayrollResult
Visitor.VisitWageTypeResult
Visitor.VisitWageTypeCustomResult
Visitor.VisitCollectorResult
Visitor.VisitCollectorCustomResult
Visitor.VisitPayrunResult
VisitorBase.Exchange
object.GetType()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: PayrollEngine.Client.Exchange
Assembly: PayrollEngine.Client.Core.dll
Syntax
public sealed class ExchangeImport : ExchangeImportVisitor

Constructors

ExchangeImport(PayrollHttpClient, Exchange, IScriptParser, ExchangeImportOptions, DataImportMode)

Initializes a new instance of the ExchangeImport class

Declaration
public ExchangeImport(PayrollHttpClient httpClient, Exchange exchange, IScriptParser scriptParser, ExchangeImportOptions importOptions = null, DataImportMode importMode = DataImportMode.Single)
Parameters
Type Name Description
PayrollHttpClient httpClient

The Payroll http client

Exchange exchange

The exchange model

IScriptParser scriptParser

The script parser

ExchangeImportOptions importOptions

The import options

DataImportMode importMode

The data import mode (default: single)

Properties

ImportMode

The data import mode

Declaration
public DataImportMode ImportMode { get; }
Property Value
Type Description
DataImportMode

Methods

ImportAsync()

Import payroll

Declaration
public Task ImportAsync()
Returns
Type Description
Task

SetupCalendarAsync(IExchangeTenant, ICalendar, ICalendar)

USer setup

Declaration
protected override Task SetupCalendarAsync(IExchangeTenant tenant, ICalendar calendar, ICalendar targetCalendar)
Parameters
Type Name Description
IExchangeTenant tenant
ICalendar calendar
ICalendar targetCalendar
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupCalendarAsync(IExchangeTenant, ICalendar, ICalendar)

SetupCaseAsync(IExchangeTenant, IRegulationSet, ICaseSet, ICase)

Case setup

Declaration
protected override Task SetupCaseAsync(IExchangeTenant tenant, IRegulationSet regulation, ICaseSet caseSet, ICase targetCase)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ICaseSet caseSet
ICase targetCase
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupCaseAsync(IExchangeTenant, IRegulationSet, ICaseSet, ICase)

SetupCaseChangeAsync(IExchangeTenant, IPayrollSet, ICaseChangeSetup)

Case change setup

Declaration
protected override Task SetupCaseChangeAsync(IExchangeTenant tenant, IPayrollSet payroll, ICaseChangeSetup caseChangeSetup)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrollSet payroll
ICaseChangeSetup caseChangeSetup
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupCaseChangeAsync(IExchangeTenant, IPayrollSet, ICaseChangeSetup)

SetupCaseFieldAsync(IExchangeTenant, IRegulationSet, ICaseSet, ICaseField, ICaseField)

Case field setup

Declaration
protected override Task SetupCaseFieldAsync(IExchangeTenant tenant, IRegulationSet regulation, ICaseSet caseSet, ICaseField caseField, ICaseField targetCaseField)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ICaseSet caseSet
ICaseField caseField
ICaseField targetCaseField
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupCaseFieldAsync(IExchangeTenant, IRegulationSet, ICaseSet, ICaseField, ICaseField)

SetupCaseRelationAsync(IExchangeTenant, IRegulationSet, ICaseRelation, ICaseRelation)

Case relation setup

Declaration
protected override Task SetupCaseRelationAsync(IExchangeTenant tenant, IRegulationSet regulation, ICaseRelation caseRelation, ICaseRelation targetCaseRelation)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ICaseRelation caseRelation
ICaseRelation targetCaseRelation
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupCaseRelationAsync(IExchangeTenant, IRegulationSet, ICaseRelation, ICaseRelation)

SetupCollectorAsync(IExchangeTenant, IRegulationSet, ICollector, ICollector)

Case relation setup

Declaration
protected override Task SetupCollectorAsync(IExchangeTenant tenant, IRegulationSet regulation, ICollector collector, ICollector targetCollector)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ICollector collector
ICollector targetCollector
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupCollectorAsync(IExchangeTenant, IRegulationSet, ICollector, ICollector)

SetupDivisionAsync(IExchangeTenant, IDivision, IDivision)

Division setup

Declaration
protected override Task SetupDivisionAsync(IExchangeTenant tenant, IDivision division, IDivision targetDivision)
Parameters
Type Name Description
IExchangeTenant tenant
IDivision division
IDivision targetDivision
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupDivisionAsync(IExchangeTenant, IDivision, IDivision)

SetupEmployeeAsync(IExchangeTenant, IEmployeeSet, IEmployee)

Employee setup

Declaration
protected override Task SetupEmployeeAsync(IExchangeTenant tenant, IEmployeeSet employee, IEmployee targetEmployee)
Parameters
Type Name Description
IExchangeTenant tenant
IEmployeeSet employee
IEmployee targetEmployee
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupEmployeeAsync(IExchangeTenant, IEmployeeSet, IEmployee)

SetupLookupAsync(IExchangeTenant, IRegulationSet, ILookupSet, ILookup)

Lookup setup

Declaration
protected override Task SetupLookupAsync(IExchangeTenant tenant, IRegulationSet regulation, ILookupSet lookup, ILookup targetLookup)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ILookupSet lookup
ILookup targetLookup
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupLookupAsync(IExchangeTenant, IRegulationSet, ILookupSet, ILookup)

SetupLookupValueAsync(IExchangeTenant, IRegulationSet, ILookupSet, ILookupValue, ILookupValue)

Lookup value setup

Declaration
protected override Task SetupLookupValueAsync(IExchangeTenant tenant, IRegulationSet regulation, ILookupSet lookup, ILookupValue lookupValue, ILookupValue targetLookupValue)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
ILookupSet lookup
ILookupValue lookupValue
ILookupValue targetLookupValue
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupLookupValueAsync(IExchangeTenant, IRegulationSet, ILookupSet, ILookupValue, ILookupValue)

SetupPayrollAsync(IExchangeTenant, IPayrollSet, IPayroll)

Payroll setup

Declaration
protected override Task SetupPayrollAsync(IExchangeTenant tenant, IPayrollSet payroll, IPayroll targetPayroll)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrollSet payroll
IPayroll targetPayroll
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupPayrollAsync(IExchangeTenant, IPayrollSet, IPayroll)

SetupPayrollLayerAsync(IExchangeTenant, IPayrollSet, IPayrollLayer, IPayrollLayer)

Payroll layer setup

Declaration
protected override Task SetupPayrollLayerAsync(IExchangeTenant tenant, IPayrollSet payroll, IPayrollLayer layer, IPayrollLayer targetLayer)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrollSet payroll
IPayrollLayer layer
IPayrollLayer targetLayer
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupPayrollLayerAsync(IExchangeTenant, IPayrollSet, IPayrollLayer, IPayrollLayer)

SetupPayrunAsync(IExchangeTenant, IPayrun, IPayrun)

Payrun setup

Declaration
protected override Task SetupPayrunAsync(IExchangeTenant tenant, IPayrun payrun, IPayrun targetPayrun)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrun payrun
IPayrun targetPayrun
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupPayrunAsync(IExchangeTenant, IPayrun, IPayrun)

SetupPayrunParameterAsync(IExchangeTenant, IPayrun, IPayrunParameter, IPayrunParameter)

Payrun setup

Declaration
protected override Task SetupPayrunParameterAsync(IExchangeTenant tenant, IPayrun payrun, IPayrunParameter parameter, IPayrunParameter targetParameter)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrun payrun
IPayrunParameter parameter
IPayrunParameter targetParameter
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupPayrunParameterAsync(IExchangeTenant, IPayrun, IPayrunParameter, IPayrunParameter)

SetupRegulationAsync(IExchangeTenant, IRegulationSet, IRegulation)

Regulation setup

Declaration
protected override Task SetupRegulationAsync(IExchangeTenant tenant, IRegulationSet regulation, IRegulation targetRegulation)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IRegulation targetRegulation
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupRegulationAsync(IExchangeTenant, IRegulationSet, IRegulation)

SetupReportAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportSet)

Report setup

Declaration
protected override Task SetupReportAsync(IExchangeTenant tenant, IRegulationSet regulation, IReportSet report, IReportSet targetReport)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IReportSet report
IReportSet targetReport
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupReportAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportSet)

SetupReportParameterAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportParameter, IReportParameter)

Report parameter setup

Declaration
protected override Task SetupReportParameterAsync(IExchangeTenant tenant, IRegulationSet regulation, IReportSet report, IReportParameter parameter, IReportParameter targetParameter)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IReportSet report
IReportParameter parameter
IReportParameter targetParameter
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupReportParameterAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportParameter, IReportParameter)

SetupReportTemplateAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportTemplate, IReportTemplate)

Report template setup

Declaration
protected override Task SetupReportTemplateAsync(IExchangeTenant tenant, IRegulationSet regulation, IReportSet report, IReportTemplate template, IReportTemplate targetTemplate)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IReportSet report
IReportTemplate template
IReportTemplate targetTemplate
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupReportTemplateAsync(IExchangeTenant, IRegulationSet, IReportSet, IReportTemplate, IReportTemplate)

SetupScriptAsync(IExchangeTenant, IRegulationSet, IScript, IScript)

Script setup

Declaration
protected override Task SetupScriptAsync(IExchangeTenant tenant, IRegulationSet regulation, IScript script, IScript targetScript)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IScript script
IScript targetScript
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupScriptAsync(IExchangeTenant, IRegulationSet, IScript, IScript)

SetupTenantAsync(IExchangeTenant, ITenant)

Tenant setup

Declaration
protected override Task SetupTenantAsync(IExchangeTenant tenant, ITenant targetTenant)
Parameters
Type Name Description
IExchangeTenant tenant
ITenant targetTenant
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupTenantAsync(IExchangeTenant, ITenant)

SetupUserAsync(IExchangeTenant, IUser, IUser)

USer setup

Declaration
protected override Task SetupUserAsync(IExchangeTenant tenant, IUser user, IUser targetUser)
Parameters
Type Name Description
IExchangeTenant tenant
IUser user
IUser targetUser
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupUserAsync(IExchangeTenant, IUser, IUser)

SetupWageTypeAsync(IExchangeTenant, IRegulationSet, IWageType, IWageType)

Wage type setup

Declaration
protected override Task SetupWageTypeAsync(IExchangeTenant tenant, IRegulationSet regulation, IWageType wageType, IWageType targetWageType)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
IWageType wageType
IWageType targetWageType
Returns
Type Description
Task
Overrides
AttachmentsLoader.SetupWageTypeAsync(IExchangeTenant, IRegulationSet, IWageType, IWageType)

SetupWebhookAsync(IExchangeTenant, IWebhook, IWebhook)

Webhook setup

Declaration
protected override Task SetupWebhookAsync(IExchangeTenant tenant, IWebhook webhook, IWebhook targetWebhook)
Parameters
Type Name Description
IExchangeTenant tenant
IWebhook webhook
IWebhook targetWebhook
Returns
Type Description
Task
Overrides
ExchangeImportVisitor.SetupWebhookAsync(IExchangeTenant, IWebhook, IWebhook)

VisitCaseChangeSetupsAsync(IExchangeTenant, IPayrollSet)

Visit the case changes

Declaration
protected override Task VisitCaseChangeSetupsAsync(IExchangeTenant tenant, IPayrollSet payroll)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrollSet payroll
Returns
Type Description
Task
Overrides
VisitorBase.VisitCaseChangeSetupsAsync(IExchangeTenant, IPayrollSet)

VisitEmployeesAsync(IExchangeTenant)

Visit the employees

Declaration
protected override Task VisitEmployeesAsync(IExchangeTenant tenant)
Parameters
Type Name Description
IExchangeTenant tenant
Returns
Type Description
Task
Overrides
VisitorBase.VisitEmployeesAsync(IExchangeTenant)

VisitLookupsAsync(IExchangeTenant, IRegulationSet)

Visit the lookups

Declaration
protected override Task VisitLookupsAsync(IExchangeTenant tenant, IRegulationSet regulation)
Parameters
Type Name Description
IExchangeTenant tenant
IRegulationSet regulation
Returns
Type Description
Task
Overrides
VisitorBase.VisitLookupsAsync(IExchangeTenant, IRegulationSet)

VisitPayrunJobInvocationAsync(IExchangeTenant, IPayrunJobInvocation)

Visit the payrun job invocation

Declaration
protected override Task VisitPayrunJobInvocationAsync(IExchangeTenant tenant, IPayrunJobInvocation invocation)
Parameters
Type Name Description
IExchangeTenant tenant
IPayrunJobInvocation invocation
Returns
Type Description
Task
Overrides
Visitor.VisitPayrunJobInvocationAsync(IExchangeTenant, IPayrunJobInvocation)

VisitRegulationShareAsync(IRegulationShare)

Visit the regulation share

Declaration
protected override Task VisitRegulationShareAsync(IRegulationShare share)
Parameters
Type Name Description
IRegulationShare share
Returns
Type Description
Task
Overrides
Visitor.VisitRegulationShareAsync(IRegulationShare)

VisitTaskAsync(IExchangeTenant, ITask)

Visit the task

Declaration
protected override Task VisitTaskAsync(IExchangeTenant tenant, ITask task)
Parameters
Type Name Description
IExchangeTenant tenant
ITask task
Returns
Type Description
Task
Overrides
Visitor.VisitTaskAsync(IExchangeTenant, ITask)

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)
☀
☾
Back to top Generated by DocFX