Class CollectorApplyRuntime

Runtime for the collector apply function

Inheritance

object

RuntimeBase

PayrollRuntime

PayrunRuntimeBase

CollectorRuntimeBase

CollectorApplyRuntime

Implements

ICollectorApplyRuntime

ICollectorRuntime

IPayrunRuntime

IPayrollRuntime

IRuntime

Inherited Members

CollectorRuntimeBase.GetResultTags()

CollectorRuntimeBase.SetResultTags(List<string>)

CollectorRuntimeBase.GetCollectorAttribute(string)

CollectorRuntimeBase.GetCollectorValue(string)

CollectorRuntimeBase.Reset()

CollectorRuntimeBase.GetResultAttribute(string)

CollectorRuntimeBase.SetResultAttribute(string, object)

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

CollectorRuntimeBase.ScheduleRetroPayrun(DateTime, List<string>)

CollectorRuntimeBase.CollectorName

CollectorRuntimeBase.CollectorGroups

CollectorRuntimeBase.CollectMode

CollectorRuntimeBase.Negated

CollectorRuntimeBase.CollectorThreshold

CollectorRuntimeBase.CollectorMinResult

CollectorRuntimeBase.CollectorMaxResult

CollectorRuntimeBase.CollectorResult

CollectorRuntimeBase.CollectorCount

CollectorRuntimeBase.CollectorSummary

CollectorRuntimeBase.CollectorMinimum

CollectorRuntimeBase.CollectorMaximum

CollectorRuntimeBase.CollectorAverage

CollectorRuntimeBase.CollectorRange

CollectorRuntimeBase.LogOwner

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.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

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 class CollectorApplyRuntime : CollectorRuntimeBase, ICollectorApplyRuntime, ICollectorRuntime, IPayrunRuntime, IPayrollRuntime, IRuntime

Constructors

CollectorApplyRuntime(PayrollHttpClient, ScriptContext, int, int, int, int?)

Initializes a new instance of the CollectorApplyRuntime class

Declaration

public CollectorApplyRuntime(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

LogOwnerType

The log owner type

Declaration

protected override string LogOwnerType { get; }

Property Value

Type	Description
string

Overrides

RuntimeBase.LogOwnerType

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

WageTypeValue

The wage type result value

Declaration

public decimal WageTypeValue { get; }

Property Value

Type	Description
decimal

Methods

GetApplyActions()

Get collector apply actions

Declaration

public string[] GetApplyActions()

Returns

Type	Description
string[]

Implements

ICollectorApplyRuntime

ICollectorRuntime

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)