Class WageTypeRuntimeBase

Runtime for the wage type function

Inheritance

object

RuntimeBase

PayrollRuntime

PayrunRuntimeBase

WageTypeRuntimeBase

WageTypeResultRuntime

WageTypeValueRuntime

Implements

IWageTypeRuntime

IPayrunRuntime

IPayrollRuntime

IRuntime

Inherited Members

PayrunRuntimeBase.GetPayrunJobAttribute(string)

PayrunRuntimeBase.SetPayrunJobAttribute(string, object)

PayrunRuntimeBase.RemovePayrunJobAttribute(string)

PayrunRuntimeBase.HasPayrunRuntimeValue(string)

PayrunRuntimeBase.GetPayrunRuntimeValue(string)

PayrunRuntimeBase.SetPayrunRuntimeValue(string, string)

PayrunRuntimeBase.HasEmployeeRuntimeValue(string)

PayrunRuntimeBase.GetEmployeeRuntimeValue(string)

PayrunRuntimeBase.SetEmployeeRuntimeValue(string, string)

PayrunRuntimeBase.GetPayrunResult(string, string)

PayrunRuntimeBase.SetPayrunResult(string, string, object, int, DateTime, DateTime, string, List<string>, Dictionary<string, object>, string)

PayrunRuntimeBase.GetWageTypeNumber(string)

PayrunRuntimeBase.GetWageTypeName(decimal)

PayrunRuntimeBase.GetWageTypeResults(IList<decimal>, DateTime, DateTime, string, int?, IList<string>)

PayrunRuntimeBase.GetConsolidatedWageTypeResults(IList<decimal>, DateTime, string, int?, IList<string>, bool)

PayrunRuntimeBase.GetWageTypeCustomResults(IList<decimal>, DateTime, DateTime, string, int?, IList<string>)

PayrunRuntimeBase.GetConsolidatedWageTypeCustomResults(IList<decimal>, DateTime, string, int?, IList<string>, bool)

PayrunRuntimeBase.GetRetroWageTypeResults(decimal, string, int?, IList<string>)

PayrunRuntimeBase.GetCollectorResults(IList<string>, DateTime, DateTime, string, int?, IList<string>)

PayrunRuntimeBase.GetConsolidatedCollectorResults(IList<string>, DateTime, string, int?, IList<string>, bool)

PayrunRuntimeBase.GetCollectorCustomResults(IList<string>, DateTime, DateTime, string, int?, IList<string>)

PayrunRuntimeBase.GetConsolidatedCollectorCustomResults(IList<string>, DateTime, string, int?, IList<string>, bool)

PayrunRuntimeBase.LogOwner

PayrunRuntimeBase.PayrunId

PayrunRuntimeBase.PayrunName

PayrunRuntimeBase.PreviewJob

PayrunRuntimeBase.ExecutionPhase

PayrunRuntimeBase.RetroPeriod

PayrunRuntimeBase.Forecast

PayrunRuntimeBase.CycleName

PayrunRuntimeBase.PeriodName

PayrollRuntime.GetEmployeeAttribute(string)

PayrollRuntime.GetEvaluationPeriod()

PayrollRuntime.GetPeriod(DateTime, int)

PayrollRuntime.GetCycle(DateTime, int)

PayrollRuntime.GetCaseValueType(string)

PayrollRuntime.GetCaseFieldAttribute(string, string)

PayrollRuntime.GetCaseValueAttribute(string, string)

PayrollRuntime.GetCaseValueSlots(string)

PayrollRuntime.GetCaseValueTags(string, DateTime)

PayrollRuntime.GetCaseValue(string, DateTime)

PayrollRuntime.GetCaseValues(IList<string>, DateTime)

PayrollRuntime.GetCaseValues(string, DateTime?, DateTime?)

PayrollRuntime.GetCasePeriodValues(DateTime, DateTime, params string[])

PayrollRuntime.HasLookup(string)

PayrollRuntime.GetLookup(string, string, string)

PayrollRuntime.GetLookupRanges(string, decimal?)

PayrollRuntime.GetRangeLookup(string, decimal, string, string)

PayrollRuntime.ApplyRangeValue(string, decimal, string)

PayrollRuntime.EmployeeService

PayrollRuntime.PayrollService

PayrollRuntime.RegulationService

PayrollRuntime.CalendarService

PayrollRuntime.ScriptContext

PayrollRuntime.ScriptCalendar

PayrollRuntime.PayrollCulture

PayrollRuntime.EmployeeId

PayrollRuntime.Employee

PayrollRuntime.EmployeeIdentifier

PayrollRuntime.PayrollId

PayrollRuntime.Payroll

PayrollRuntime.DivisionId

PayrollRuntime.Namespace

PayrollRuntime.Cycle

PayrollRuntime.Period

PayrollRuntime.RegulationDate

PayrollRuntime.EvaluationDate

RuntimeBase.GetTenantAttribute(string)

RuntimeBase.GetUserAttribute(string)

RuntimeBase.GetDerivedCulture(int, int)

RuntimeBase.GetDerivedCalendar(int, int)

RuntimeBase.GetCalendarDayCount(string, DateTime, DateTime, string)

RuntimeBase.IsCalendarWorkDay(string, DateTime)

RuntimeBase.GetPreviousWorkDays(string, DateTime)

RuntimeBase.GetNextWorkDays(string, DateTime)

RuntimeBase.GetCalendarPeriod(string, DateTime, int, string)

RuntimeBase.AddLog(int, string, string, string)

RuntimeBase.AddTask(string, string, DateTime, string, Dictionary<string, object>)

RuntimeBase.InvokeWebhook(string, string)

RuntimeBase.HttpClient

RuntimeBase.TenantService

RuntimeBase.UserService

RuntimeBase.Tenant

RuntimeBase.TenantCulture

RuntimeBase.TenantId

RuntimeBase.TenantIdentifier

RuntimeBase.User

RuntimeBase.UserId

RuntimeBase.UserIdentifier

RuntimeBase.UserCulture

RuntimeBase.UserType

RuntimeBase.LogOwnerType

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client.Scripting.Runtime.Api

Assembly: PayrollEngine.Client.Services.dll

Syntax

public abstract class WageTypeRuntimeBase : PayrunRuntimeBase, IWageTypeRuntime, IPayrunRuntime, IPayrollRuntime, IRuntime

Constructors

WageTypeRuntimeBase(PayrollHttpClient, ScriptContext, int, int, int, int?)

Initializes a new instance of the WageTypeRuntimeBase class

Declaration

protected WageTypeRuntimeBase(PayrollHttpClient httpClient, ScriptContext scriptContext, int tenantId, int userId, int payrollId, int? employeeId = null)

Parameters

Type	Name	Description
PayrollHttpClient	httpClient	The Payroll http client
ScriptContext	scriptContext	The script context
int	tenantId	The tenant id
int	userId	The user id
int	payrollId	The payroll id
int?	employeeId	The employee id

Properties

CollectorGroups

The wage type collector groups

Declaration

public string[] CollectorGroups { get; }

Property Value

Type	Description
string[]

Collectors

The wage type collectors

Declaration

public string[] Collectors { get; }

Property Value

Type	Description
string[]

WageTypeCalendar

The wage type calendar

Declaration

public string WageTypeCalendar { get; }

Property Value

Type	Description
string

WageTypeDescription

The wage type description

Declaration

public string WageTypeDescription { get; }

Property Value

Type	Description
string

WageTypeName

The wage type name

Declaration

public string WageTypeName { get; }

Property Value

Type	Description
string

WageTypeNumber

The wage type number

Declaration

public decimal WageTypeNumber { get; }

Property Value

Type	Description
decimal

Methods

AddCustomResult(string, decimal, DateTime, DateTime, List<string>, Dictionary<string, object>, int?, string)

Add a wage type custom result

Declaration

public void AddCustomResult(string source, decimal value, DateTime startDate, DateTime endDate, List<string> tags, Dictionary<string, object> attributes, int? valueType, string culture)

Parameters

Type	Name	Description
string	source	The value source
decimal	value	The period value
DateTime	startDate	The start date
DateTime	endDate	The end date
List<string>	tags	The result tags
Dictionary<string, object>	attributes	The wage type custom result attributes
int?	valueType	The result value type (numeric), default is the wage type value type
string	culture	The result culture

DisableCollector(string)

Disable collector for the current employee job

Declaration

public void DisableCollector(string collectorName)

Parameters

Type	Name	Description
string	collectorName	Name of the collector

EnableCollector(string)

Reenable disabled collector for the current employee job

Declaration

public void EnableCollector(string collectorName)

Parameters

Type	Name	Description
string	collectorName	Name of the collector

GetCollector(string)

Gets the collector value

Declaration

public decimal GetCollector(string collectorName)

Parameters

Type	Name	Description
string	collectorName	Name of the collector

Returns

Type	Description
decimal	The collector value

GetResultAttribute(string)

Gets wage result attribute value

Declaration

public object GetResultAttribute(string name)

Parameters

Type	Name	Description
string	name	The attribute name

Returns

Type	Description
object	The attribute value

GetResultTags()

Get the wage type result tags

Declaration

public List<string> GetResultTags()

Returns

Type	Description
List<string>	The wage type result tags

GetWageType(decimal)

Gets the wage type value

Declaration

public decimal GetWageType(decimal wageTypeNumber)

Parameters

Type	Name	Description
decimal	wageTypeNumber	The wage type number

Returns

Type	Description
decimal	The wage type value

GetWageType(string)

Gets the wage type value

Declaration

public decimal GetWageType(string wageTypeName)

Parameters

Type	Name	Description
string	wageTypeName	The wage type name

Returns

Type	Description
decimal	The wage type value

GetWageTypeAttribute(string)

Get wage type attribute value

Declaration

public object GetWageTypeAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName	Name of the attribute

Returns

Type	Description
object	The wage type attribute value

ScheduleRetroPayrun(DateTime, List<string>)

Schedule a retro payrun

Declaration

public void ScheduleRetroPayrun(DateTime scheduleDate, List<string> resultTags)

Parameters

Type	Name	Description
DateTime	scheduleDate	The payrun schedule date, must be before the current period
List<string>	resultTags	The result tags

SetResultAttribute(string, object)

Sets the wage result attribute value

Declaration

public void SetResultAttribute(string name, object value)

Parameters

Type	Name	Description
string	name	The attribute name
object	value	The attribute value

SetResultTags(List<string>)

Set the wage type result tags

Declaration

public void SetResultTags(List<string> tags)

Parameters

Type	Name	Description
List<string>	tags	The wage type result tags

Implements

IWageTypeRuntime

IPayrunRuntime

IPayrollRuntime

IRuntime

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)