Interface ICollectorRuntime

Runtime for the collector function CollectorFunction

Inherited Members

IPayrunRuntime.GetPayrunJobAttribute(string)

IPayrunRuntime.SetPayrunJobAttribute(string, object)

IPayrunRuntime.RemovePayrunJobAttribute(string)

IPayrunRuntime.HasPayrunRuntimeValue(string)

IPayrunRuntime.GetPayrunRuntimeValue(string)

IPayrunRuntime.SetPayrunRuntimeValue(string, string)

IPayrunRuntime.HasEmployeeRuntimeValue(string)

IPayrunRuntime.GetEmployeeRuntimeValue(string)

IPayrunRuntime.SetEmployeeRuntimeValue(string, string)

IPayrunRuntime.GetPayrunResult(string, string)

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

IPayrunRuntime.GetWageTypeNumber(string)

IPayrunRuntime.GetWageTypeName(decimal)

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

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

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

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

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

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

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

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

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

IPayrunRuntime.PayrunId

IPayrunRuntime.PayrunName

IPayrunRuntime.ExecutionPhase

IPayrunRuntime.RetroPeriod

IPayrunRuntime.Forecast

IPayrunRuntime.CycleName

IPayrunRuntime.PeriodName

IPayrunRuntime.PreviewJob

IPayrollRuntime.GetEmployeeAttribute(string)

IPayrollRuntime.GetEvaluationPeriod()

IPayrollRuntime.GetPeriod(DateTime, int)

IPayrollRuntime.GetCycle(DateTime, int)

IPayrollRuntime.GetCaseValueType(string)

IPayrollRuntime.GetCaseFieldAttribute(string, string)

IPayrollRuntime.GetCaseValueAttribute(string, string)

IPayrollRuntime.GetCaseValueSlots(string)

IPayrollRuntime.GetCaseValueTags(string, DateTime)

IPayrollRuntime.GetCaseValue(string, DateTime)

IPayrollRuntime.GetCaseValues(IList<string>, DateTime)

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

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

IPayrollRuntime.HasLookup(string)

IPayrollRuntime.GetLookup(string, string, string)

IPayrollRuntime.GetLookupRanges(string, decimal?)

IPayrollRuntime.GetRangeLookup(string, decimal, string, string)

IPayrollRuntime.ApplyRangeValue(string, decimal, string)

IPayrollRuntime.EmployeeId

IPayrollRuntime.EmployeeIdentifier

IPayrollRuntime.PayrollCulture

IPayrollRuntime.PayrollId

IPayrollRuntime.Namespace

IPayrollRuntime.DivisionId

IPayrollRuntime.EvaluationDate

IRuntime.GetTenantAttribute(string)

IRuntime.GetUserAttribute(string)

IRuntime.GetDerivedCulture(int, int)

IRuntime.GetDerivedCalendar(int, int)

IRuntime.GetCalendarDayCount(string, DateTime, DateTime, string)

IRuntime.IsCalendarWorkDay(string, DateTime)

IRuntime.GetPreviousWorkDays(string, DateTime)

IRuntime.GetNextWorkDays(string, DateTime)

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

IRuntime.AddLog(int, string, string, string)

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

IRuntime.InvokeWebhook(string, string)

IRuntime.TenantId

IRuntime.TenantIdentifier

IRuntime.UserId

IRuntime.UserIdentifier

IRuntime.UserCulture

IRuntime.UserType

Namespace: PayrollEngine.Client.Scripting.Runtime

Assembly: PayrollEngine.Client.Scripting.dll

Syntax

public interface ICollectorRuntime : IPayrunRuntime, IPayrollRuntime, IRuntime

Properties

CollectMode

The collect mode

Declaration

string CollectMode { get; }

Property Value

Type	Description
string

CollectorAverage

The average of the collected values

Declaration

decimal CollectorAverage { get; }

Property Value

Type	Description
decimal

CollectorCount

Collected values count

Declaration

decimal CollectorCount { get; }

Property Value

Type	Description
decimal

CollectorGroups

The collector groups

Declaration

string[] CollectorGroups { get; }

Property Value

Type	Description
string[]

CollectorMaxResult

The maximum allowed value

Declaration

decimal? CollectorMaxResult { get; }

Property Value

Type	Description
decimal?

CollectorMaximum

The maximum collected values

Declaration

decimal CollectorMaximum { get; }

Property Value

Type	Description
decimal

CollectorMinResult

The minimum allowed value

Declaration

decimal? CollectorMinResult { get; }

Property Value

Type	Description
decimal?

CollectorMinimum

The minimum collected values

Declaration

decimal CollectorMinimum { get; }

Property Value

Type	Description
decimal

CollectorName

The collector name

Declaration

string CollectorName { get; }

Property Value

Type	Description
string

CollectorRange

The range of the collected values

Declaration

decimal CollectorRange { get; }

Property Value

Type	Description
decimal

CollectorResult

The current collector result

Declaration

decimal CollectorResult { get; }

Property Value

Type	Description
decimal

CollectorSummary

The summary of the collected values

Declaration

decimal CollectorSummary { get; }

Property Value

Type	Description
decimal

CollectorThreshold

The threshold value

Declaration

decimal? CollectorThreshold { get; }

Property Value

Type	Description
decimal?

Negated

Negated collector result

Declaration

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

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

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

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

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

List<string> GetResultTags()

Returns

Type	Description
List<string>	The wage type result tags

Reset()

Resets the collector to his initial state

Declaration

void Reset()

ScheduleRetroPayrun(DateTime, List<string>)

Schedule a retro payrun

Declaration

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

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

void SetResultTags(List<string> tags)

Parameters

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

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)