Class WageTypeFunction

Wage type function

Inheritance

object

Function

PayrollFunction

PayrunFunction

WageTypeFunction

WageTypeResultFunction

WageTypeValueFunction

Implements

IDisposable

Inherited Members

PayrunFunction.GetCycleWageTypeValue(decimal)

PayrunFunction.GetCycleWageTypeValue(string)

PayrunFunction.GetRetroWageTypeValueSumByNumber(decimal)

PayrunFunction.GetRetroWageTypeValueSumByName(string)

PayrunFunction.GetCycleCollectorValue(string)

PayrunFunction.GetRuntimeValue(string)

PayrunFunction.SetRuntimeValue(string, object)

PayrunFunction.RemoveRuntimeValue(string)

PayrunFunction.GetPayrunResultValue(string)

PayrunFunction.SetPayrunResultValue(string, object, string)

PayrunFunction.GetPayrunJobAttribute(string)

PayrunFunction.GetPayrunJobAttribute<T>(string, T)

PayrunFunction.SetPayrunJobAttribute(string, object)

PayrunFunction.RemovePayrunJobAttribute(string)

PayrunFunction.HasPayrunRuntimeValue(string)

PayrunFunction.GetPayrunRuntimeValue(string)

PayrunFunction.GetPayrunRuntimeValue<T>(string)

PayrunFunction.SetPayrunRuntimeValue(string, string)

PayrunFunction.SetPayrunRuntimeValue<T>(string, T)

PayrunFunction.HasEmployeeRuntimeValue(string)

PayrunFunction.GetEmployeeRuntimeValue(string)

PayrunFunction.GetEmployeeRuntimeValue<T>(string)

PayrunFunction.SetEmployeeRuntimeValue(string, string)

PayrunFunction.SetEmployeeRuntimeValue<T>(string, T)

PayrunFunction.GetPayrunResult(string)

PayrunFunction.GetPayrunResult<T>(string, T)

PayrunFunction.SetPayrunResult(string, object, ValueType?, string, IEnumerable<string>, Dictionary<string, object>, string)

PayrunFunction.SetPayrunResult(string, object, DateTime, DateTime, ValueType?, string, IEnumerable<string>, Dictionary<string, object>, string)

PayrunFunction.GetWageTypeNumber(string)

PayrunFunction.GetWageTypeName(decimal)

PayrunFunction.GetWageTypeCycleResults(WageTypeCycleResultQuery)

PayrunFunction.GetPeriodWageTypeResults(WageTypePeriodResultQuery)

PayrunFunction.GetWageTypeResults(WageTypeRangeResultQuery)

PayrunFunction.GetWageTypeResults(IEnumerable<decimal>, DateTime, DateTime, string, PayrunJobStatus?, IEnumerable<string>)

PayrunFunction.GetConsolidatedWageTypeResults(WageTypeConsolidatedResultQuery)

PayrunFunction.GetWageTypeCustomResults(WageTypeRangeResultQuery)

PayrunFunction.GetConsolidatedWageTypeCustomResults(WageTypeConsolidatedResultQuery)

PayrunFunction.GetWageTypeRetroResults(WageTypeResultQuery)

PayrunFunction.GetWageTypeRetroResultSum(decimal)

PayrunFunction.GetRetroWageTypeValueSum(decimal)

PayrunFunction.GetRetroWageTypeValueSum(string)

PayrunFunction.GetCollectorCycleResults(CollectorCycleResultQuery)

PayrunFunction.GetCollectorPeriodResults(CollectorPeriodResultQuery)

PayrunFunction.GetCollectorResults(CollectorRangeResultQuery)

PayrunFunction.GetCollectorResults(IEnumerable<string>, DateTime, DateTime, string, PayrunJobStatus?, IEnumerable<string>)

PayrunFunction.GetConsolidatedCollectorResults(CollectorConsolidatedResultQuery)

PayrunFunction.GetConsolidatedCollectorCustomResults(CollectorConsolidatedResultQuery)

PayrunFunction.PayrunId

PayrunFunction.PayrunName

PayrunFunction.PreviewJob

PayrunFunction.ExecutionPhase

PayrunFunction.RetroPeriod

PayrunFunction.IsRetroPayrun

PayrunFunction.IsCycleRetroPayrun

PayrunFunction.Forecast

PayrunFunction.IsForecast

PayrunFunction.CycleName

PayrunFunction.PeriodName

PayrollFunction.StringType

PayrollFunction.IntType

PayrollFunction.NumericType

PayrollFunction.DecimalType

PayrollFunction.DateType

PayrollFunction.TimeSpanType

PayrollFunction.BooleanType

PayrollFunction.HasFieldValue(string)

PayrollFunction.GetFieldValue(string)

PayrollFunction.HasLookupValue(string, ActionValue, string)

PayrollFunction.HasLookupValue(string, ActionValue, ActionValue, string)

PayrollFunction.GetLookupValue(string, ActionValue, string)

PayrollFunction.GetLookupValue(string, ActionValue, ActionValue, string)

PayrollFunction.ApplyRangeLookupValue(string, decimal, string)

PayrollFunction.Min(params ActionValue[])

PayrollFunction.Min(ActionValue, ActionValue)

PayrollFunction.Max(params ActionValue[])

PayrollFunction.Max(ActionValue, ActionValue)

PayrollFunction.Within(ActionValue, ActionValue, ActionValue)

PayrollFunction.Range(ActionValue, ActionValue, ActionValue)

PayrollFunction.Concat(params ActionValue[])

PayrollFunction.Contains(ActionValue, params ActionValue[])

PayrollFunction.GetTimeSpan(ActionValue, ActionValue)

PayrollFunction.SameYear(ActionValue, ActionValue)

PayrollFunction.SameMonth(ActionValue, ActionValue)

PayrollFunction.SameDay(ActionValue, ActionValue)

PayrollFunction.YearDiff(ActionValue, ActionValue)

PayrollFunction.Age(ActionValue, ActionValue)

PayrollFunction.IsNull(ActionValue)

PayrollFunction.IsNotNull(ActionValue)

PayrollFunction.IfNull(ActionValue, ActionValue)

PayrollFunction.IIf(bool, ActionValue, ActionValue)

PayrollFunction.SetNamespace(string, string)

PayrollFunction.Log(string, LogLevel)

PayrollFunction.GetCalendarPeriod(DateTime?, int)

PayrollFunction.GetCalendarDayCount(string)

PayrollFunction.GetEmployeeAttribute(string)

PayrollFunction.GetEmployeeAttribute<T>(string, T)

PayrollFunction.GetCycle(int)

PayrollFunction.GetCycle(DateTime, int)

PayrollFunction.GetPeriods(int, int)

PayrollFunction.GetCyclePeriods()

PayrollFunction.GetPastCyclePeriods(bool)

PayrollFunction.GetFutureCyclePeriods(bool)

PayrollFunction.IsFirstCycleDay(DateTime)

PayrollFunction.IsLastCycleDay(DateTime)

PayrollFunction.PastPeriod()

PayrollFunction.FuturePeriod()

PayrollFunction.GetPeriod(int)

PayrollFunction.GetPeriod(DateTime, int)

PayrollFunction.GetPeriodOffset(DateTime)

PayrollFunction.IsFirstPeriodDay(DateTime)

PayrollFunction.IsLastPeriodDay(DateTime)

PayrollFunction.GetCaseValueType(string)

PayrollFunction.HasCaseFieldAttribute(string, string)

PayrollFunction.GetCaseFieldAttribute(string, string)

PayrollFunction.GetCaseFieldAttribute<T>(string, string, T)

PayrollFunction.HasCaseValueAttribute(string, string)

PayrollFunction.GetCaseValueAttribute(string, string)

PayrollFunction.GetCaseValueAttribute<T>(string, string, T)

PayrollFunction.TestAvailableCaseValues(IEnumerable<string>)

PayrollFunction.TestAvailableCaseValues(DatePeriod, IEnumerable<string>)

PayrollFunction.GetFirstAvailableCaseValue(IEnumerable<string>)

PayrollFunction.GetFirstAvailableCaseValue(DatePeriod, IEnumerable<string>)

PayrollFunction.GetFirstUnavailableCaseValue(IEnumerable<string>)

PayrollFunction.GetFirstUnavailableCaseValue(DatePeriod, IEnumerable<string>)

PayrollFunction.CaseFieldSlot(string, string)

PayrollFunction.GetPeriodCaseValue<T>(DatePeriod, string, string)

PayrollFunction.GetPeriodCaseValue(DatePeriod, string, string)

PayrollFunction.GetPeriodCaseValues(DatePeriod, params string[])

PayrollFunction.GetPeriodCaseValues(int, params string[])

PayrollFunction.GetPeriodCaseValue<T>(int, string, string)

PayrollFunction.GetPeriodCaseValue(int, string, string)

PayrollFunction.GetCaseValue<T>(string, string)

PayrollFunction.GetCaseValue(string, string)

PayrollFunction.GetPeriodCaseValue(int, int, string, string)

PayrollFunction.GetMultiPeriodCaseValues(int, int, params string[])

PayrollFunction.GetRawCaseValue(string, DateTime)

PayrollFunction.GetRawCaseValues(IList<string>, DateTime)

PayrollFunction.GetRawCaseValue<T>(string, DateTime)

PayrollFunction.GetPeriodRawCaseValues(string, DatePeriod)

PayrollFunction.GetPeriodRawCaseValues(string)

PayrollFunction.GetPeriodRawCaseValues(string, int)

PayrollFunction.GetRawCaseValues(string, DateTime?, DateTime?)

PayrollFunction.GetCaseObjectValues<T>(bool, bool)

PayrollFunction.GetCaseObject<T>(List<CasePayrollValue>, DateTime)

PayrollFunction.GetRawCaseObject<T>(DateTime, bool)

PayrollFunction.GetPeriodRawCaseObjects<T>(List<DateTime>, bool)

PayrollFunction.GetCaseValues(params string[])

PayrollFunction.GetCaseValueTags(string)

PayrollFunction.GetCaseValueTags(string, DateTime)

PayrollFunction.GetCaseValueSlots(string)

PayrollFunction.GetSlotValues(string)

PayrollFunction.GetSlotValues<T>(string)

PayrollFunction.GetSlotByValue(string, string, string)

PayrollFunction.HasLookup(string)

PayrollFunction.GetLookup<T>(string, string, string)

PayrollFunction.GetLookup<T>(string, object[], string)

PayrollFunction.GetObjectLookup<T>(string, string, string, string)

PayrollFunction.GetLookupRanges(string, decimal?)

PayrollFunction.GetLookupThresholdRange(string, decimal)

PayrollFunction.GetLookupProgressiveRanges(string, decimal)

PayrollFunction.GetRangeLookup<T>(string, decimal, string, string)

PayrollFunction.GetRangeObjectLookup<T>(string, decimal, string, string, string)

PayrollFunction.ApplyRangeValue(string, decimal, string)

PayrollFunction.GetAttributeIssue(string, params object[])

PayrollFunction.None

PayrollFunction.Null

PayrollFunction.PayrollId

PayrollFunction.Namespace

PayrollFunction.HasNamespace

PayrollFunction.DivisionId

PayrollFunction.PayrollCulture

PayrollFunction.EmployeeId

PayrollFunction.EmployeeIdentifier

PayrollFunction.CycleStart

PayrollFunction.CycleStartYear

PayrollFunction.CycleStartMonth

PayrollFunction.CycleStartDay

PayrollFunction.CycleEnd

PayrollFunction.CycleEndYear

PayrollFunction.CycleEndMonth

PayrollFunction.CycleEndDay

PayrollFunction.CycleDuration

PayrollFunction.Cycle

PayrollFunction.CycleDays

PayrollFunction.PreviousCycle

PayrollFunction.NextCycle

PayrollFunction.EvaluationDate

PayrollFunction.EvaluationPeriod

PayrollFunction.Periods

PayrollFunction.PeriodStart

PayrollFunction.PeriodStartYear

PayrollFunction.PeriodStartMonth

PayrollFunction.PeriodStartDay

PayrollFunction.PeriodEnd

PayrollFunction.PeriodEndYear

PayrollFunction.PeriodEndMonth

PayrollFunction.PeriodEndDay

PayrollFunction.PeriodDuration

PayrollFunction.Period

PayrollFunction.PeriodDays

PayrollFunction.PreviousPeriod

PayrollFunction.NextPeriod

PayrollFunction.FirstCyclePeriod

PayrollFunction.LastCyclePeriod

PayrollFunction.CycleStartOffset

PayrollFunction.CycleEndOffset

PayrollFunction.PastCyclePeriods

PayrollFunction.FutureCyclePeriods

PayrollFunction.PeriodsInCycle

PayrollFunction.CaseValue

PayrollFunction.CaseValueTags

Function.GetTenantAttribute(string)

Function.GetTenantAttribute<T>(string, T)

Function.GetUserAttribute(string)

Function.GetUserAttribute<T>(string, T)

Function.GetDerivedCulture(int, int)

Function.GetDerivedCalendar(int, int)

Function.GetCalendarDayCount(DateTime, DateTime, string)

Function.GetCalendarDayCount(string, DateTime, DateTime, string)

Function.IsCalendarWorkDay(string, DateTime?)

Function.IsCalendarWorkDay(DateTime?)

Function.GetPreviousWorkDay(string, DateTime?)

Function.GetPreviousWorkDays(string, DateTime?, int)

Function.GetNextWorkDay(string, DateTime?)

Function.GetNextWorkDays(string, DateTime?, int)

Function.GetCalendarPeriod(DateTime?, int, int, int)

Function.GetCalendarPeriod(string, DateTime?, int, string)

Function.LogVerbose(string, string, string)

Function.LogDebug(string, string, string)

Function.LogInformation(string, string, string)

Function.LogWarning(string, string, string)

Function.LogError(string, string, string)

Function.LogError(Exception, string, string)

Function.LogFatal(string, string, string)

Function.LogFatal(Exception, string, string)

Function.Log(LogLevel, string, string, string)

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

Function.InvokeWebhook<T>(string, object)

Function.GetSourceFileName(string)

Function.ChangeValueType<T>(object, T, IFormatProvider)

Function.Dispose()

Function.Runtime

Function.TenantId

Function.TenantIdentifier

Function.UserId

Function.UserIdentifier

Function.UserCulture

Function.UserType

Function.SelfServiceUser

Function.AdminUser

Function.SourceFileName

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client.Scripting.Function

Assembly: PayrollEngine.Client.Scripting.dll

Syntax

public abstract class WageTypeFunction : PayrunFunction, IDisposable

Constructors

WageTypeFunction(object)

Initializes a new instance with the function runtime

Declaration

protected WageTypeFunction(object runtime)

Parameters

Type	Name	Description
object	runtime	The runtime

WageTypeFunction(string)

New function instance without runtime (scripting development)

Declaration

protected WageTypeFunction(string sourceFileName)

Parameters

Type	Name	Description
string	sourceFileName	The name of the source file

Properties

Attribute

Get or set a wage type result attribute value

Declaration

public ScriptDictionary<string, object> Attribute { get; }

Property Value

Type	Description
ScriptDictionary<string, object>

AttributePayrollValue

Get or set a wage type result attribute PayrollValue

Declaration

public ScriptDictionary<string, PayrollValue> AttributePayrollValue { get; }

Property Value

Type	Description
ScriptDictionary<string, PayrollValue>

Collector

Get a collector value by collector name

Declaration

public ScriptDictionary<string, decimal> Collector { get; }

Property Value

Type	Description
ScriptDictionary<string, decimal>

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

WageType

Get a wage type value by wage type number

Declaration

public ScriptDictionary<decimal, decimal> WageType { get; }

Property Value

Type	Description
ScriptDictionary<decimal, decimal>

WageTypeCalendar

The wage type calendar

Declaration

[ActionProperty("Wage type calendar", null)]
public string WageTypeCalendar { get; }

Property Value

Type	Description
string

WageTypeDescription

The wage type description

Declaration

[ActionProperty("Wage type description", null)]
public string WageTypeDescription { get; }

Property Value

Type	Description
string

WageTypeName

The wage type name

Declaration

[ActionProperty("Wage type name", null)]
public string WageTypeName { get; }

Property Value

Type	Description
string

WageTypeNumber

The wage type number

Declaration

[ActionProperty("Wage type number", null)]
public decimal WageTypeNumber { get; }

Property Value

Type	Description
decimal

Methods

AddCustomResult(string, IEnumerable<string>, Dictionary<string, object>, ValueType?, string)

Add wage type custom result from case field values, using the current period

Declaration

public void AddCustomResult(string source, IEnumerable<string> tags = null, Dictionary<string, object> attributes = null, ValueType? valueType = null, string culture = null)

Parameters

Type	Name	Description
string	source	The value source
IEnumerable<string>	tags	The result tags
Dictionary<string, object>	attributes	The wage type custom result attributes
ValueType?	valueType	The result value type (numeric), default is the wage type value type
string	culture	The result culture

AddCustomResult(string, DateTime, DateTime, IEnumerable<string>, Dictionary<string, object>, ValueType?, string)

Add wage type custom result from case field values

Declaration

public void AddCustomResult(string source, DateTime startDate, DateTime endDate, IEnumerable<string> tags = null, Dictionary<string, object> attributes = null, ValueType? valueType = null, string culture = null)

Parameters

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

AddCustomResult(string, decimal, IEnumerable<string>, Dictionary<string, object>, ValueType?, string)

Add wage type custom result from case field values, using the current period

Declaration

public void AddCustomResult(string source, decimal value, IEnumerable<string> tags = null, Dictionary<string, object> attributes = null, ValueType? valueType = null, string culture = null)

Parameters

Type	Name	Description
string	source	The value source
decimal	value	The period value
IEnumerable<string>	tags	The result tags
Dictionary<string, object>	attributes	The wage type custom result attributes
ValueType?	valueType	The result value type (numeric), default is the wage type value type
string	culture	The result culture

AddCustomResult(string, decimal, DateTime, DateTime, IEnumerable<string>, Dictionary<string, object>, ValueType?, string)

Add a wage type custom result

Declaration

public void AddCustomResult(string source, decimal value, DateTime startDate, DateTime endDate, IEnumerable<string> tags = null, Dictionary<string, object> attributes = null, ValueType? valueType = null, string culture = null)

Parameters

Type	Name	Description
string	source	The value source
decimal	value	The period value
DateTime	startDate	The start date
DateTime	endDate	The end date
IEnumerable<string>	tags	The result tags
Dictionary<string, object>	attributes	The wage type custom result attributes
ValueType?	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

GetCollectorCurrentConsolidatedValue(CollectorConsolidatedResultQuery)

Get consolidated and current period employee collector results by query

Declaration

public decimal GetCollectorCurrentConsolidatedValue(CollectorConsolidatedResultQuery query)

Parameters

Type	Name	Description
CollectorConsolidatedResultQuery	query	The result query

Returns

Type	Description
decimal	Consolidated employee collector results

GetCollectorValue(string)

Get collector value

Declaration

[ActionParameter("name", "The collector name", new string[] { "String" }, null, null)]
[WageTypeAction("GetCollectorValue", "Get collector value", new string[] { "WageType" })]
public ActionValue GetCollectorValue(string name)

Parameters

Type	Name	Description
string	name	Collector name

Returns

Type	Description
ActionValue

GetResultAttribute(string)

Get wage result attribute

Declaration

public object GetResultAttribute(string name)

Parameters

Type	Name	Description
string	name	The attribute name

Returns

Type	Description
object

GetResultAttribute<T>(string, T)

Get wage result attribute typed value

Declaration

public T GetResultAttribute<T>(string attributeName, T defaultValue = default)

Parameters

Type	Name	Description
string	attributeName
T	defaultValue

Returns

Type	Description
T

Type Parameters

Name	Description
T

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

Declaration

public object GetWageTypeAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName

Returns

Type	Description
object

GetWageTypeAttribute<T>(string, T)

Get attribute typed value

Declaration

public T GetWageTypeAttribute<T>(string attributeName, T defaultValue = default)

Parameters

Type	Name	Description
string	attributeName
T	defaultValue

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetWageTypeCurrentConsolidatedValue(WageTypeConsolidatedResultQuery)

Get consolidated and current period employee wage type results by query

Declaration

public decimal GetWageTypeCurrentConsolidatedValue(WageTypeConsolidatedResultQuery query)

Parameters

Type	Name	Description
WageTypeConsolidatedResultQuery	query	The result query

Returns

Type	Description
decimal	Consolidated employee collector results

GetWageTypeValueByName(string)

Get wage type value by name

Declaration

[ActionParameter("name", "The wage type name", new string[] { "String" }, null, null)]
[WageTypeAction("GetWageTypeValueByName", "Get wage type value by name", new string[] { "WageType" })]
public ActionValue GetWageTypeValueByName(string name)

Parameters

Type	Name	Description
string	name	Wage type number

Returns

Type	Description
ActionValue

GetWageTypeValueByNumber(decimal)

Get wage type value by number

Declaration

[ActionParameter("number", "Get wage type value by number", new string[] { "Dec" }, null, null)]
[WageTypeAction("GetWageTypeValueByNumber", "Get wage type value", new string[] { "WageType" })]
public ActionValue GetWageTypeValueByNumber(decimal number)

Parameters

Type	Name	Description
decimal	number	Wage type number

Returns

Type	Description
ActionValue

ScheduleRetroPayrun(DateTime, IEnumerable<string>)

Schedule a retro payrun

Declaration

public void ScheduleRetroPayrun(DateTime scheduleDate, IEnumerable<string> resultTags = null)

Parameters

Type	Name	Description
DateTime	scheduleDate	The payrun schedule date, must be before the current period
IEnumerable<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(IEnumerable<string>)

Set the collector result tags

Declaration

public void SetResultTags(IEnumerable<string> tags)

Parameters

Type	Name	Description
IEnumerable<string>	tags	The result tags

Implements

IDisposable

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)