Interface ICaseChangeRuntime

Runtime for the case change function CaseChangeFunction

Inherited Members

ICaseRuntime.GetCaseAttribute(string)

ICaseRuntime.CaseName

ICaseRuntime.CaseType

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 ICaseChangeRuntime : ICaseRuntime, IPayrollRuntime, IRuntime

Properties

CancellationDate

Get the cancellation date

Declaration

DateTime? CancellationDate { get; }

Property Value

Type	Description
DateTime?

Methods

AddCaseValueTag(string, string)

Add case value tag

Declaration

bool AddCaseValueTag(string caseFieldName, string tag)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	tag	The tag to add

Returns

Type	Description
bool	True if the case value tag has been added

CaseAvailable(string)

Test if a case is available

Declaration

bool CaseAvailable(string caseName)

Parameters

Type	Name	Description
string	caseName	The name of the case

Returns

Type	Description
bool	True if the case is available

FieldAvailable(string)

Test if a case field is available

Declaration

bool FieldAvailable(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case field is available

FieldAvailable(string, bool)

Set if the case field is available

Declaration

void FieldAvailable(string caseFieldName, bool available)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
bool	available	The case field available value

GetEnd(string)

Get the case end date by his field name

Declaration

DateTime? GetEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
DateTime?	The case end date

GetFieldNames()

Get field names

Declaration

string[] GetFieldNames()

Returns

Type	Description
string[]

GetForecast()

Get the case change forecast

Declaration

string GetForecast()

Returns

Type	Description
string

GetReason()

Get the case change reason

Declaration

string GetReason()

Returns

Type	Description
string

GetStart(string)

Get the case start date by his field name

Declaration

DateTime? GetStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
DateTime?	The source case start date

GetValue(string)

Get a case value by his field name, in context of the script

Declaration

object GetValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
object

GetValueType(string)

Get a case value type

Declaration

int GetValueType(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
int

HasEnd(string)

Test if a case end date is defined

Declaration

bool HasEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case end date is available

HasField(string)

Test if a case field is defined

Declaration

bool HasField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case field is available

HasFields()

Test if the case contains fields

Declaration

bool HasFields()

Returns

Type	Description
bool

HasStart(string)

Test if a case start date is defined

Declaration

bool HasStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case start date is available

HasValue(string)

Test if a case value is defined

Declaration

bool HasValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool

InitEnd(string, DateTime?)

Initialize the case end date by his field name

Declaration

void InitEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
DateTime?	end	The end date to initialize

InitStart(string, DateTime?)

Initialize the case start date by his field name

Declaration

void InitStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
DateTime?	start	The start date to initialize

InitValue(string, object)

Initialize the case value by his field name

Declaration

void InitValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
object	value	The value to initialize

IsFieldComplete(string)

Test if a case field is complete

Declaration

bool IsFieldComplete(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case field is complete

IsFieldEmpty(string)

Test if a case field is empty (no start, end and value)

Declaration

bool IsFieldEmpty(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case field is empty

MandatoryEnd(string)

Test if a case end date is mandatory

Declaration

bool MandatoryEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case end date is mandatory

MandatoryValue(string)

Test if a case value is mandatory

Declaration

bool MandatoryValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
bool	True if the case value is mandatory

RemoveCaseAttribute(string, string)

Remove case attribute

Declaration

bool RemoveCaseAttribute(string caseName, string attributeName)

Parameters

Type	Name	Description
string	caseName	The name of the case
string	attributeName	The name of the case attribute

Returns

Type	Description
bool	True if the case attribute has been removed

RemoveCaseFieldAttribute(string, string)

Remove case field attribute

Declaration

bool RemoveCaseFieldAttribute(string caseFieldName, string attributeName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute

Returns

Type	Description
bool	True if the case field attribute has been removed

RemoveCaseValueAttribute(string, string)

Remove case field value attribute

Declaration

bool RemoveCaseValueAttribute(string caseFieldName, string attributeName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute

Returns

Type	Description
bool	True if the case field attribute has been removed

RemoveCaseValueTag(string, string)

Remove case value tag

Declaration

bool RemoveCaseValueTag(string caseFieldName, string tag)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	tag	The tag to remove

Returns

Type	Description
bool	True if the case value tag has been removed

SetCaseAttribute(string, string, object)

Set case attribute value

Declaration

void SetCaseAttribute(string caseName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseName	The name of the case
string	attributeName	The name of the case attribute
object	value	The value of the case attribute

SetCaseFieldAttribute(string, string, object)

Set case field attribute value

Declaration

void SetCaseFieldAttribute(string caseFieldName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute
object	value	The value of the case field attribute

SetCaseValueAttribute(string, string, object)

Set case field value attribute value

Declaration

void SetCaseValueAttribute(string caseFieldName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute
object	value	The value of the case field value attribute

SetEnd(string, DateTime?)

Set the case end date by his field name

Declaration

void SetEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
DateTime?	end	The end date to set

SetForecast(string)

Set the case change forecast

Declaration

void SetForecast(string forecast)

Parameters

Type	Name	Description
string	forecast

SetReason(string)

Set the case change reason

Declaration

void SetReason(string reason)

Parameters

Type	Name	Description
string	reason

SetStart(string, DateTime?)

Set the case start date by his field name

Declaration

void SetStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
DateTime?	start	The start date to set

SetValue(string, object)

Set the target case value by his field name

Declaration

void SetValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
object	value	The value to set

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)