Class PayrollService

Inheritance

object

ServiceBase

PayrollService

Implements

IPayrollService

ICrudService<IPayroll, TenantServiceContext, Query>

ICreateService<IPayroll, TenantServiceContext, Query>

IReadService<IPayroll, TenantServiceContext, Query>

IAttributeService<TenantServiceContext>

Inherited Members

ServiceBase.AddQueryValue(string, string, object)

ServiceBase.AddQueryValue(string, string, DateTime)

ServiceBase.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client.Service.Api

Assembly: PayrollEngine.Client.Core.dll

Syntax

public class PayrollService : ServiceBase, IPayrollService, ICrudService<IPayroll, TenantServiceContext, Query>, ICreateService<IPayroll, TenantServiceContext, Query>, IReadService<IPayroll, TenantServiceContext, Query>, IAttributeService<TenantServiceContext>

Constructors

PayrollService(PayrollHttpClient)

Declaration

public PayrollService(PayrollHttpClient httpClient)

Parameters

Type	Name	Description
PayrollHttpClient	httpClient

Methods

AddCaseAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext, TCaseChangeSetup)

Declaration

public virtual Task<TCaseChange> AddCaseAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext context, TCaseChangeSetup caseChangeSetup) where TCaseChangeSetup : class, ICaseChangeSetup where TCaseChange : class, ICaseChange

Parameters

Type	Name	Description
PayrollServiceContext	context
TCaseChangeSetup	caseChangeSetup

Returns

Type	Description
Task<TCaseChange>

Type Parameters

Name	Description
TCaseChangeSetup
TCaseChange

AddCasesBulkAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext, IEnumerable<TCaseChangeSetup>)

Declaration

public Task<int> AddCasesBulkAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext context, IEnumerable<TCaseChangeSetup> caseChangeSetups) where TCaseChangeSetup : class, ICaseChangeSetup where TCaseChange : class, ICaseChange

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<TCaseChangeSetup>	caseChangeSetups

Returns

Type	Description
Task<int>

Type Parameters

Name	Description
TCaseChangeSetup
TCaseChange

BuildCaseAsync<TCaseSet>(PayrollServiceContext, string, int, int?, string, string, DateTime?, DateTime?, ICaseChangeSetup)

Declaration

public virtual Task<TCaseSet> BuildCaseAsync<TCaseSet>(PayrollServiceContext context, string caseName, int userId, int? employeeId = null, string clusterSetName = null, string culture = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, ICaseChangeSetup caseChangeSetup = null) where TCaseSet : class, ICaseSet

Parameters

Type	Name	Description
PayrollServiceContext	context
string	caseName
int	userId
int?	employeeId
string	clusterSetName
string	culture
DateTime?	regulationDate
DateTime?	evaluationDate
ICaseChangeSetup	caseChangeSetup

Returns

Type	Description
Task<TCaseSet>

Type Parameters

Name	Description
TCaseSet

CreateAsync<T>(TenantServiceContext, T)

Declaration

public virtual Task<T> CreateAsync<T>(TenantServiceContext context, T payroll) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
T	payroll

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

DeleteAsync(TenantServiceContext, int)

Declaration

public virtual Task DeleteAsync(TenantServiceContext context, int payrollId)

Parameters

Type	Name	Description
TenantServiceContext	context
int	payrollId

Returns

Type	Description
Task

DeleteAttributeAsync(TenantServiceContext, int, string)

Declaration

public virtual Task DeleteAttributeAsync(TenantServiceContext context, int payrollId, string attributeName)

Parameters

Type	Name	Description
TenantServiceContext	context
int	payrollId
string	attributeName

Returns

Type	Description
Task

GetActionsAsync<TAction>(PayrollServiceContext, IEnumerable<string>, OverrideType?, FunctionType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TAction>> GetActionsAsync<TAction>(PayrollServiceContext context, IEnumerable<string> scriptNames = null, OverrideType? overrideType = null, FunctionType? functionType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TAction : ActionInfo

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	scriptNames
OverrideType?	overrideType
FunctionType?	functionType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TAction>>

Type Parameters

Name	Description
TAction

GetAsync<T>(TenantServiceContext, int)

Declaration

public virtual Task<T> GetAsync<T>(TenantServiceContext context, int payrollId) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
int	payrollId

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

GetAsync<T>(TenantServiceContext, string)

Declaration

public virtual Task<T> GetAsync<T>(TenantServiceContext context, string name) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
string	name

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

GetAttributeAsync(TenantServiceContext, int, string)

Declaration

public virtual Task<string> GetAttributeAsync(TenantServiceContext context, int payrollId, string attributeName)

Parameters

Type	Name	Description
TenantServiceContext	context
int	payrollId
string	attributeName

Returns

Type	Description
Task<string>

GetAvailableCaseFieldValuesAsync(PayrollServiceContext, int, IEnumerable<string>, DateTime, DateTime, int?, DateTime?, DateTime?, string)

Declaration

public virtual Task<List<CaseFieldValue>> GetAvailableCaseFieldValuesAsync(PayrollServiceContext context, int userId, IEnumerable<string> caseFieldNames, DateTime startDate, DateTime endDate, int? employeeId = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context
int	userId
IEnumerable<string>	caseFieldNames
DateTime	startDate
DateTime	endDate
int?	employeeId
DateTime?	regulationDate
DateTime?	evaluationDate
string	culture

Returns

Type	Description
Task<List<CaseFieldValue>>

GetAvailableCasesAsync<TCase>(PayrollServiceContext, int, CaseType, IEnumerable<string>, int?, string, string, string, bool?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TCase>> GetAvailableCasesAsync<TCase>(PayrollServiceContext context, int userId, CaseType caseType, IEnumerable<string> caseNames = null, int? employeeId = null, string caseSlot = null, string clusterSetName = null, string culture = null, bool? hidden = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCase : class, ICase

Parameters

Type	Name	Description
PayrollServiceContext	context
int	userId
CaseType	caseType
IEnumerable<string>	caseNames
int?	employeeId
string	caseSlot
string	clusterSetName
string	culture
bool?	hidden
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TCase>>

Type Parameters

Name	Description
TCase

GetCaseFieldsAsync<TCaseField>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TCaseField>> GetCaseFieldsAsync<TCaseField>(PayrollServiceContext context, IEnumerable<string> caseFieldNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCaseField : class, ICaseField

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	caseFieldNames
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TCaseField>>

Type Parameters

Name	Description
TCaseField

GetCaseRelationsAsync<TCaseRelation>(PayrollServiceContext, string, string, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TCaseRelation>> GetCaseRelationsAsync<TCaseRelation>(PayrollServiceContext context, string sourceCaseName = null, string targetCaseName = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCaseRelation : class, ICaseRelation

Parameters

Type	Name	Description
PayrollServiceContext	context
string	sourceCaseName
string	targetCaseName
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TCaseRelation>>

Type Parameters

Name	Description
TCaseRelation

GetCaseTimeValuesAsync(PayrollServiceContext, CaseType, int?, IEnumerable<string>, DateTime?, DateTime?, DateTime?)

Declaration

public virtual Task<List<CaseValue>> GetCaseTimeValuesAsync(PayrollServiceContext context, CaseType caseType, int? employeeId = null, IEnumerable<string> caseFieldNames = null, DateTime? valueDate = null, DateTime? regulationDate = null, DateTime? evaluationDate = null)

Parameters

Type	Name	Description
PayrollServiceContext	context
CaseType	caseType
int?	employeeId
IEnumerable<string>	caseFieldNames
DateTime?	valueDate
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<CaseValue>>

GetCaseValuesAsync(PayrollServiceContext, DateTime, DateTime, IEnumerable<string>, int?, DateTime?, DateTime?, string)

Declaration

public virtual Task<List<CaseFieldValue>> GetCaseValuesAsync(PayrollServiceContext context, DateTime startDate, DateTime endDate, IEnumerable<string> caseFieldNames, int? employeeId = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string caseSlot = null)

Parameters

Type	Name	Description
PayrollServiceContext	context
DateTime	startDate
DateTime	endDate
IEnumerable<string>	caseFieldNames
int?	employeeId
DateTime?	regulationDate
DateTime?	evaluationDate
string	caseSlot

Returns

Type	Description
Task<List<CaseFieldValue>>

GetCasesAsync<TCase>(PayrollServiceContext, CaseType?, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TCase>> GetCasesAsync<TCase>(PayrollServiceContext context, CaseType? caseType = null, IEnumerable<string> caseNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCase : class, ICase

Parameters

Type	Name	Description
PayrollServiceContext	context
CaseType?	caseType
IEnumerable<string>	caseNames
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TCase>>

Type Parameters

Name	Description
TCase

GetCollectorsAsync<TCollector>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TCollector>> GetCollectorsAsync<TCollector>(PayrollServiceContext context, IEnumerable<string> collectorNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCollector : class, ICollector

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	collectorNames
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TCollector>>

Type Parameters

Name	Description
TCollector

GetLookupDataAsync<TLookupData>(PayrollServiceContext, IEnumerable<string>, DateTime?, DateTime?, string)

Declaration

public virtual Task<List<TLookupData>> GetLookupDataAsync<TLookupData>(PayrollServiceContext context, IEnumerable<string> lookupNames, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null) where TLookupData : class, ILookupData

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	lookupNames
DateTime?	regulationDate
DateTime?	evaluationDate
string	culture

Returns

Type	Description
Task<List<TLookupData>>

Type Parameters

Name	Description
TLookupData

GetLookupRangesAsync(PayrollServiceContext, IEnumerable<string>, decimal?, DateTime?, DateTime?, string)

Declaration

public virtual Task<List<LookupRangeResult>> GetLookupRangesAsync(PayrollServiceContext context, IEnumerable<string> lookupNames, decimal? rangeValue = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	lookupNames
decimal?	rangeValue
DateTime?	regulationDate
DateTime?	evaluationDate
string	culture

Returns

Type	Description
Task<List<LookupRangeResult>>

GetLookupValueDataAsync(PayrollServiceContext, string, string, decimal?, DateTime?, DateTime?, string)

Declaration

public virtual Task<LookupValueData> GetLookupValueDataAsync(PayrollServiceContext context, string lookupName, string lookupKey = null, decimal? rangeValue = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context
string	lookupName
string	lookupKey
decimal?	rangeValue
DateTime?	regulationDate
DateTime?	evaluationDate
string	culture

Returns

Type	Description
Task<LookupValueData>

GetLookupValuesAsync<TLookupValue>(PayrollServiceContext, IEnumerable<string>, IEnumerable<string>, DateTime?, DateTime?)

Declaration

public virtual Task<List<TLookupValue>> GetLookupValuesAsync<TLookupValue>(PayrollServiceContext context, IEnumerable<string> lookupNames = null, IEnumerable<string> lookupKeys = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TLookupValue : class, ILookupValue

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	lookupNames
IEnumerable<string>	lookupKeys
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TLookupValue>>

Type Parameters

Name	Description
TLookupValue

GetLookupsAsync<TLookup>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TLookup>> GetLookupsAsync<TLookup>(PayrollServiceContext context, IEnumerable<string> lookupNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TLookup : class, ILookup

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	lookupNames
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TLookup>>

Type Parameters

Name	Description
TLookup

GetRegulationsAsync<T>(PayrollServiceContext, DateTime?, DateTime?)

Declaration

public virtual Task<List<T>> GetRegulationsAsync<T>(PayrollServiceContext context, DateTime? regulationDate = null, DateTime? evaluationDate = null) where T : class, IRegulation

Parameters

Type	Name	Description
PayrollServiceContext	context
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<T>>

Type Parameters

Name	Description
T

GetReportParametersAsync<TReportParameter>(PayrollServiceContext, IEnumerable<string>, DateTime?, DateTime?)

Declaration

public virtual Task<List<TReportParameter>> GetReportParametersAsync<TReportParameter>(PayrollServiceContext context, IEnumerable<string> reportNames, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportParameter : class, IReportParameter

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	reportNames
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TReportParameter>>

Type Parameters

Name	Description
TReportParameter

GetReportTemplatesAsync<TReportTemplate>(PayrollServiceContext, IEnumerable<string>, string, DateTime?, DateTime?)

Declaration

public virtual Task<List<TReportTemplate>> GetReportTemplatesAsync<TReportTemplate>(PayrollServiceContext context, IEnumerable<string> reportNames, string culture = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportTemplate : class, IReportTemplate

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	reportNames
string	culture
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TReportTemplate>>

Type Parameters

Name	Description
TReportTemplate

GetReportsAsync<TReportSet>(PayrollServiceContext, IEnumerable<string>, OverrideType?, UserType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TReportSet>> GetReportsAsync<TReportSet>(PayrollServiceContext context, IEnumerable<string> reportNames = null, OverrideType? overrideType = null, UserType? userType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportSet : class, IReportSet

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	reportNames
OverrideType?	overrideType
UserType?	userType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TReportSet>>

Type Parameters

Name	Description
TReportSet

GetScriptsAsync<TScript>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TScript>> GetScriptsAsync<TScript>(PayrollServiceContext context, IEnumerable<string> scriptNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TScript : class, IScript

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<string>	scriptNames
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TScript>>

Type Parameters

Name	Description
TScript

GetWageTypesAsync<TWageType>(PayrollServiceContext, IEnumerable<decimal>, OverrideType?, DateTime?, DateTime?)

Declaration

public virtual Task<List<TWageType>> GetWageTypesAsync<TWageType>(PayrollServiceContext context, IEnumerable<decimal> wageTypeNumbers = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TWageType : class, IWageType

Parameters

Type	Name	Description
PayrollServiceContext	context
IEnumerable<decimal>	wageTypeNumbers
OverrideType?	overrideType
DateTime?	regulationDate
DateTime?	evaluationDate

Returns

Type	Description
Task<List<TWageType>>

Type Parameters

Name	Description
TWageType

QueryAsync<T>(TenantServiceContext, Query)

Declaration

public virtual Task<List<T>> QueryAsync<T>(TenantServiceContext context, Query query = null) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
Query	query

Returns

Type	Description
Task<List<T>>

Type Parameters

Name	Description
T

QueryCountAsync(TenantServiceContext, Query)

Declaration

public virtual Task<long> QueryCountAsync(TenantServiceContext context, Query query = null)

Parameters

Type	Name	Description
TenantServiceContext	context
Query	query

Returns

Type	Description
Task<long>

QueryResultAsync<T>(TenantServiceContext, Query)

Declaration

public virtual Task<QueryResult<T>> QueryResultAsync<T>(TenantServiceContext context, Query query = null) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
Query	query

Returns

Type	Description
Task<QueryResult<T>>

Type Parameters

Name	Description
T

SetAttributeAsync(TenantServiceContext, int, string, string)

Declaration

public virtual Task SetAttributeAsync(TenantServiceContext context, int payrollId, string attributeName, string attributeValue)

Parameters

Type	Name	Description
TenantServiceContext	context
int	payrollId
string	attributeName
string	attributeValue

Returns

Type	Description
Task

UpdateAsync<T>(TenantServiceContext, T)

Declaration

public virtual Task UpdateAsync<T>(TenantServiceContext context, T payroll) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context
T	payroll

Returns

Type	Description
Task

Type Parameters

Name	Description
T

Implements

IPayrollService

ICrudService<TModel, TContext, TQuery>

ICreateService<TModel, TContext, TQuery>

IReadService<TModel, TContext, TQuery>

IAttributeService<TContext>

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)