Interface IPayrunJobService

Payroll payrun job service

Inherited Members

ICrudService<IPayrunJob, TenantServiceContext, Query>.UpdateAsync<T>(TenantServiceContext, T)

ICreateService<IPayrunJob, TenantServiceContext, Query>.CreateAsync<T>(TenantServiceContext, T)

ICreateService<IPayrunJob, TenantServiceContext, Query>.DeleteAsync(TenantServiceContext, int)

IReadService<IPayrunJob, TenantServiceContext, Query>.QueryAsync<T>(TenantServiceContext, Query)

IReadService<IPayrunJob, TenantServiceContext, Query>.QueryCountAsync(TenantServiceContext, Query)

IReadService<IPayrunJob, TenantServiceContext, Query>.QueryResultAsync<T>(TenantServiceContext, Query)

IReadService<IPayrunJob, TenantServiceContext, Query>.GetAsync<T>(TenantServiceContext, int)

IAttributeService<TenantServiceContext>.GetAttributeAsync(TenantServiceContext, int, string)

IAttributeService<TenantServiceContext>.SetAttributeAsync(TenantServiceContext, int, string, string)

IAttributeService<TenantServiceContext>.DeleteAttributeAsync(TenantServiceContext, int, string)

Namespace: PayrollEngine.Client.Service

Assembly: PayrollEngine.Client.Core.dll

Syntax

public interface IPayrunJobService : ICrudService<IPayrunJob, TenantServiceContext, Query>, ICreateService<IPayrunJob, TenantServiceContext, Query>, IReadService<IPayrunJob, TenantServiceContext, Query>, IAttributeService<TenantServiceContext>

Methods

ChangeJobStatusAsync(TenantServiceContext, int, PayrunJobStatus, int, string, bool)

Get the status of a payrun job

Declaration

Task ChangeJobStatusAsync(TenantServiceContext context, int payrunJobId, PayrunJobStatus jobStatus, int userId, string reason, bool patchMode)

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
int	payrunJobId	The payrun job id
PayrunJobStatus	jobStatus	The target payrun job status
int	userId	The user id
string	reason	The change reason id
bool	patchMode	The patch mode

Returns

Type	Description
Task	The payrun job status

GetAsync<T>(TenantServiceContext, string)

Get payrun job by identifier

Declaration

Task<T> GetAsync<T>(TenantServiceContext context, string name) where T : class, IPayrunJob

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
string	name	The payrun job name

Returns

Type	Description
Task<T>	The payrun job, null if missing

Type Parameters

Name	Description
T

GetJobStatusAsync(TenantServiceContext, int)

Get the status of a payrun job

Declaration

Task<string> GetJobStatusAsync(TenantServiceContext context, int payrunJobId)

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
int	payrunJobId	The payrun job id

Returns

Type	Description
Task<string>	The payrun job status

PreviewJobAsync<T>(TenantServiceContext, PayrunJobInvocation)

Preview a payrun job for a single employee (synchronous). Returns calculation results as a PayrollResultSet without persisting to the database.

Declaration

Task<T> PreviewJobAsync<T>(TenantServiceContext context, PayrunJobInvocation jobInvocation) where T : class, IPayrollResultSet

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
PayrunJobInvocation	jobInvocation	The payrun job invocation with exactly one employee identifier

Returns

Type	Description
Task<T>	The payroll result set containing wage type results, collector results, and payrun results

Type Parameters

Name	Description
T

QueryEmployeePayrunJobsAsync<T>(TenantServiceContext, int, Query)

Query employee payrun jobs

Declaration

Task<List<T>> QueryEmployeePayrunJobsAsync<T>(TenantServiceContext context, int employeeId, Query query = null) where T : class, IPayrunJob

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
int	employeeId	The employee id
Query	query	The query parameters

Returns

Type	Description
Task<List<T>>	Payrun jobs of the employee

Type Parameters

Name	Description
T

QueryEmployeePayrunJobsCountAsync(TenantServiceContext, int, Query)

Query employee payrun jobs count

Declaration

Task<long> QueryEmployeePayrunJobsCountAsync(TenantServiceContext context, int employeeId, Query query = null)

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
int	employeeId	The employee id
Query	query	The query parameters

Returns

Type	Description
Task<long>	Payrun jobs of the employee

QueryEmployeePayrunJobsCountAsync<T>(TenantServiceContext, int, Query)

Query items and count of objects

Declaration

Task<QueryResult<T>> QueryEmployeePayrunJobsCountAsync<T>(TenantServiceContext context, int employeeId, Query query = null) where T : class, IPayrunJob

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
int	employeeId	The employee id
Query	query	The query

Returns

Type	Description
Task<QueryResult<T>>	List and count of objects

Type Parameters

Name	Description
T

StartJobAsync<T>(TenantServiceContext, PayrunJobInvocation)

Start a payrun job, if the payroll has no previous draft payrun

Declaration

Task<T> StartJobAsync<T>(TenantServiceContext context, PayrunJobInvocation jobInvocation) where T : class, IPayrunJob

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
PayrunJobInvocation	jobInvocation	The payrun job invocation

Returns

Type	Description
Task<T>	The newly created payrun job

Type Parameters

Name	Description
T

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)