Class CaseRelationRuntimeBase

Runtime for the case relation function

Inheritance

object

RuntimeBase

PayrollRuntime

CaseRelationRuntimeBase

CaseRelationBuildRuntime

CaseRelationValidateRuntime

Implements

ICaseRelationRuntime

IPayrollRuntime

IRuntime

Inherited Members

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 CaseRelationRuntimeBase : PayrollRuntime, ICaseRelationRuntime, IPayrollRuntime, IRuntime

Constructors

CaseRelationRuntimeBase(PayrollHttpClient, ScriptContext, int, int, int, CaseSet, CaseSet, int?)

Initializes a new instance of the CaseRelationRuntimeBase class

Declaration

protected CaseRelationRuntimeBase(PayrollHttpClient httpClient, ScriptContext scriptContext, int tenantId, int userId, int payrollId, CaseSet sourceCaseSet, CaseSet targetCaseSet, 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
CaseSet	sourceCaseSet	The source case set
CaseSet	targetCaseSet	The target case set
int?	employeeId	The employee id

Properties

LogOwner

The log owner type

Declaration

protected override string LogOwner { get; }

Property Value

Type	Description
string

Overrides

RuntimeBase.LogOwner

RelationName

Gets the case relation name

Declaration

protected string RelationName { get; }

Property Value

Type	Description
string

SourceCaseCancellationDate

Get the source case cancellation date

Declaration

public DateTime? SourceCaseCancellationDate { get; }

Property Value

Type	Description
DateTime?

SourceCaseName

Gets the name of the source case

Declaration

public string SourceCaseName { get; }

Property Value

Type	Description
string

SourceCaseSet

The source case set

Declaration

public CaseSet SourceCaseSet { get; }

Property Value

Type	Description
CaseSet

SourceCaseSlot

Gets the source case slot

Declaration

public string SourceCaseSlot { get; }

Property Value

Type	Description
string

TargetCaseCancellationDate

Get the target case cancellation date

Declaration

public DateTime? TargetCaseCancellationDate { get; }

Property Value

Type	Description
DateTime?

TargetCaseName

Gets the name of the target case

Declaration

public string TargetCaseName { get; }

Property Value

Type	Description
string

TargetCaseSet

The target case set

Declaration

public CaseSet TargetCaseSet { get; }

Property Value

Type	Description
CaseSet

TargetCaseSlot

Gets the target case slot

Declaration

public string TargetCaseSlot { get; }

Property Value

Type	Description
string

Methods

CopyEnd(string, string)

Copy the case field end date from source to target

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public string[] GetSourceFieldNames()

Returns

Type	Description
string[]

GetSourceStart(string)

Get the source case start date by his field name

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public string[] GetTargetFieldNames()

Returns

Type	Description
string[]

GetTargetStart(string)

Get the target case start date by his field name

Declaration

public 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

public 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

public 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

public 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

public 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

public bool HasSourceFields()

Returns

Type	Description
bool

HasSourceStart(string)

Test if a source case start date is defined

Declaration

public 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

public 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

public 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

public 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

public bool HasTargetFields()

Returns

Type	Description
bool

HasTargetStart(string)

Test if a target case start date is defined

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public void TargetFieldAvailable(string caseFieldName, bool available)

Parameters

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

Implements

ICaseRelationRuntime

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)