Class CollectorRuntimeBase

Runtime for the collector function

Inheritance

object

RuntimeBase

PayrollRuntime

PayrunRuntimeBase

CollectorRuntimeBase

CollectorApplyRuntime

CollectorEndRuntime

CollectorStartRuntime

Implements

ICollectorRuntime

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.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 CollectorRuntimeBase : PayrunRuntimeBase, ICollectorRuntime, IPayrunRuntime, IPayrollRuntime, IRuntime

Constructors

CollectorRuntimeBase(PayrollHttpClient, ScriptContext, int, int, int, int?)

Initializes a new instance of the CollectorRuntimeBase class

Declaration

protected CollectorRuntimeBase(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

CollectMode

The collect mode

Declaration

public string CollectMode { get; }

Property Value

Type	Description
string

CollectorAverage

The average of the collected values

Declaration

public decimal CollectorAverage { get; }

Property Value

Type	Description
decimal

CollectorCount

Collected values count

Declaration

public decimal CollectorCount { get; }

Property Value

Type	Description
decimal

CollectorGroups

The collector groups

Declaration

public string[] CollectorGroups { get; }

Property Value

Type	Description
string[]

CollectorMaxResult

The maximum allowed value

Declaration

public decimal? CollectorMaxResult { get; }

Property Value

Type	Description
decimal?

CollectorMaximum

The maximum collected values

Declaration

public decimal CollectorMaximum { get; }

Property Value

Type	Description
decimal

CollectorMinResult

The minimum allowed value

Declaration

public decimal? CollectorMinResult { get; }

Property Value

Type	Description
decimal?

CollectorMinimum

The minimum collected values

Declaration

public decimal CollectorMinimum { get; }

Property Value

Type	Description
decimal

CollectorName

The collector name

Declaration

public string CollectorName { get; }

Property Value

Type	Description
string

CollectorRange

The range of the collected values

Declaration

public decimal CollectorRange { get; }

Property Value

Type	Description
decimal

CollectorResult

The current collector result

Declaration

public decimal CollectorResult { get; }

Property Value

Type	Description
decimal

CollectorSummary

The summary of the collected values

Declaration

public decimal CollectorSummary { get; }

Property Value

Type	Description
decimal

CollectorThreshold

The threshold value

Declaration

public decimal? CollectorThreshold { get; }

Property Value

Type	Description
decimal?

LogOwner

The log owner type

Declaration

protected override string LogOwner { get; }

Property Value

Type	Description
string

Overrides

PayrunRuntimeBase.LogOwner

Negated

Negated collector result

Declaration

public bool Negated { get; }

Property Value

Type	Description
bool

Methods

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

Add a custom collector 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 collector result attributes
int?	valueType	The result value type (numeric), default is the collector value type
string	culture	The result culture

GetCollectorAttribute(string)

Get attribute value

Declaration

public object GetCollectorAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName	Name of the attribute

Returns

Type	Description
object	The collector attribute value

GetCollectorValue(string)

Gets the collector value

Declaration

public decimal GetCollectorValue(string collectorName)

Parameters

Type	Name	Description
string	collectorName	Name of the collector

Returns

Type	Description
decimal	The collector value

GetResultAttribute(string)

Gets the 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

Reset()

Resets the collector to his initial state

Declaration

public void Reset()

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

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)