Show / Hide Table of Contents

Interface ICaseRelationRuntime

Runtime for the case relation function CaseRelationFunction

Inherited Members
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 ICaseRelationRuntime : IPayrollRuntime, IRuntime

Properties

SourceCaseCancellationDate

Get the source case cancellation date

Declaration
DateTime? SourceCaseCancellationDate { get; }
Property Value
Type Description
DateTime?

SourceCaseName

Gets the name of the source case

Declaration
string SourceCaseName { get; }
Property Value
Type Description
string

SourceCaseSlot

Gets the source case slot

Declaration
string SourceCaseSlot { get; }
Property Value
Type Description
string

TargetCaseCancellationDate

Get the target case cancellation date

Declaration
DateTime? TargetCaseCancellationDate { get; }
Property Value
Type Description
DateTime?

TargetCaseName

Gets the name of the target case

Declaration
string TargetCaseName { get; }
Property Value
Type Description
string

TargetCaseSlot

Gets the target case slot

Declaration
string TargetCaseSlot { get; }
Property Value
Type Description
string

Methods

CopyEnd(string, string)

Copy the case field end date from source to target

Declaration
void CopyEnd(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

CopyStart(string, string)

Copy the case field start date from source to target

Declaration
void CopyStart(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

CopyValue(string, string)

Copy the case field value from source to target

Declaration
void CopyValue(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

GetSourceCaseAttribute(string)

Get source case attribute value

Declaration
object GetSourceCaseAttribute(string attributeName)
Parameters
Type Name Description
string attributeName

Name of the attribute

Returns
Type Description
object

The source case attribute value

GetSourceCaseFieldAttribute(string, string)

Get source case field attribute value

Declaration
object GetSourceCaseFieldAttribute(string caseFieldName, string attributeName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

string attributeName

Name of the attribute

Returns
Type Description
object

The source case field value

GetSourceCaseValueAttribute(string, string)

Get source case value attribute value

Declaration
object GetSourceCaseValueAttribute(string caseFieldName, string attributeName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

string attributeName

Name of the attribute

Returns
Type Description
object

The source case field value

GetSourceEnd(string)

Get the source case end date by his field name

Declaration
DateTime? GetSourceEnd(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
DateTime?

The source case end date

GetSourceFieldNames()

Get source field names

Declaration
string[] GetSourceFieldNames()
Returns
Type Description
string[]

GetSourceStart(string)

Get the source case start date by his field name

Declaration
DateTime? GetSourceStart(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
DateTime?

The source case start date

GetSourceValue(string)

Get the source case value by his field name

Declaration
object GetSourceValue(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
object

The source case value

GetSourceValueType(string)

Get the source case value type

Declaration
int GetSourceValueType(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
int

GetTargetCaseAttribute(string)

Get target case attribute value

Declaration
object GetTargetCaseAttribute(string attributeName)
Parameters
Type Name Description
string attributeName

Name of the attribute

Returns
Type Description
object

The target case attribute value

GetTargetCaseFieldAttribute(string, string)

Get target case field attribute value

Declaration
object GetTargetCaseFieldAttribute(string caseFieldName, string attributeName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

string attributeName

Name of the attribute

Returns
Type Description
object

The target case field attribute value

GetTargetCaseValueAttribute(string, string)

Get target case value attribute value

Declaration
object GetTargetCaseValueAttribute(string caseFieldName, string attributeName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

string attributeName

Name of the attribute

Returns
Type Description
object

The target case field attribute value

GetTargetEnd(string)

Get the target case end date by his field name

Declaration
DateTime? GetTargetEnd(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
DateTime?

The target case end date

GetTargetFieldNames()

Get target field names

Declaration
string[] GetTargetFieldNames()
Returns
Type Description
string[]

GetTargetStart(string)

Get the target case start date by his field name

Declaration
DateTime? GetTargetStart(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
DateTime?

The target case start date

GetTargetValue(string)

Get the target case value by his field name

Declaration
object GetTargetValue(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
object

The target case value

GetTargetValueType(string)

Get the target case value type

Declaration
int GetTargetValueType(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
int

HasSourceEnd(string)

Test if a source case end date is defined

Declaration
bool HasSourceEnd(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the source case end date is available

HasSourceField(string)

Test if a source case field is defined

Declaration
bool HasSourceField(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the source case field is available

HasSourceFields()

Test if the source case contains fields

Declaration
bool HasSourceFields()
Returns
Type Description
bool

HasSourceStart(string)

Test if a source case start date is defined

Declaration
bool HasSourceStart(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the source case start date is available

HasSourceValue(string)

Test if the source case value is defined

Declaration
bool HasSourceValue(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the case value is available

HasTargetEnd(string)

Test if a target case end date is defined

Declaration
bool HasTargetEnd(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the target case end date is available

HasTargetField(string)

Test if a target case field is defined

Declaration
bool HasTargetField(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the target case field is available

HasTargetFields()

Test if the target case contains fields

Declaration
bool HasTargetFields()
Returns
Type Description
bool

HasTargetStart(string)

Test if a target case start date is defined

Declaration
bool HasTargetStart(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the target case start date is available

HasTargetValue(string)

Test if the target case value is defined

Declaration
bool HasTargetValue(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the target value is available

InitEnd(string, string)

Initializes the target case field end date from the source case field

Declaration
void InitEnd(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

InitStart(string, string)

Initializes the target case field start date from the source case field

Declaration
void InitStart(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

InitTargetEnd(string, DateTime?)

Initialize the target end

Declaration
void InitTargetEnd(string caseFieldName, DateTime? end)
Parameters
Type Name Description
string caseFieldName

The name of the case field

DateTime? end

The end date to set

InitTargetStart(string, DateTime?)

Initialize the target start

Declaration
void InitTargetStart(string caseFieldName, DateTime? start)
Parameters
Type Name Description
string caseFieldName

The name of the case field

DateTime? start

The start date to set

InitTargetValue(string, object)

Initialize the target end

Declaration
void InitTargetValue(string caseFieldName, object value)
Parameters
Type Name Description
string caseFieldName
object value

InitValue(string, string)

Initializes the target case field value from the source case field

Declaration
void InitValue(string sourceFieldName, string targetFieldName)
Parameters
Type Name Description
string sourceFieldName

The name of the source case field

string targetFieldName

The name of the target case field

IsSourceFieldComplete(string)

Test if a source case field is complete

Declaration
bool IsSourceFieldComplete(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the source case field is complete

IsSourceFieldEmpty(string)

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

Declaration
bool IsSourceFieldEmpty(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

IsTargetFieldComplete(string)

Test if a target case field is complete

Declaration
bool IsTargetFieldComplete(string caseFieldName)
Parameters
Type Name Description
string caseFieldName

The name of the case field

Returns
Type Description
bool

True if the target case field is complete

IsTargetFieldEmpty(string)

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

Declaration
bool IsTargetFieldEmpty(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

SetTargetEnd(string, DateTime?)

Set the target case end date by his field name

Declaration
void SetTargetEnd(string caseFieldName, DateTime? end)
Parameters
Type Name Description
string caseFieldName

The name of the case field

DateTime? end

The end date to set

SetTargetStart(string, DateTime?)

Set the target case start date by his field name

Declaration
void SetTargetStart(string caseFieldName, DateTime? start)
Parameters
Type Name Description
string caseFieldName

The name of the case field

DateTime? start

The start date to set

SetTargetValue(string, object)

Set the target case value by his field name

Declaration
void SetTargetValue(string caseFieldName, object value)
Parameters
Type Name Description
string caseFieldName

The name of the case field

object value

The value to set

TargetFieldAvailable(string)

Test if a target case field is available

Declaration
bool TargetFieldAvailable(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

TargetFieldAvailable(string, bool)

Set if the target case field is available

Declaration
void TargetFieldAvailable(string caseFieldName, bool available)
Parameters
Type Name Description
string caseFieldName

The name of the case field

bool available

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)
☀
☾
Back to top Generated by DocFX