Class CaseRelationFunction

Base class for case relation functions that operate on a source/target case pair.

Inheritance

object

Function

PayrollFunction

CaseRelationFunction

CaseRelationBuildFunction

CaseRelationValidateFunction

Implements

IDisposable

Inherited Members

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 CaseRelationFunction : PayrollFunction, IDisposable

Remarks

A case relation links a source case to a target case. When a user submits the source case, the engine evaluates the relation and can propagate or transform values into the target case.

This base class exposes two symmetric sets of accessors:

• Source — read-only: SourceValue, SourceStart, SourceEnd, GetSourceFieldNames(), and related test/attribute methods.
• Target — read-write: TargetValue, TargetStart, TargetEnd, InitTargetValue(string, object), and related methods.

Helper methods CopyValue(string, string), CopyStart(string, string), CopyEnd(string, string), InitValue(string, string), InitStart(string, string), and InitEnd(string, string) simplify direct field-to-field transfer between source and target.

Two concrete functions inherit from this class:

• CaseRelationBuildFunction — populates target fields from source values.
• CaseRelationValidateFunction — validates the combined source/target state.

Constructors

CaseRelationFunction(object)

Initializes a new instance with the function runtime

Declaration

protected CaseRelationFunction(object runtime)

Parameters

Type	Name	Description
object	runtime	The runtime

CaseRelationFunction(string)

New function instance without runtime (scripting development)

Declaration

protected CaseRelationFunction(string sourceFileName)

Parameters

Type	Name	Description
string	sourceFileName	The name of the source file

Remarks

Use GetSourceFileName(string) in your constructor for the source file name

Properties

SourceCaseCancellation

Get the source cancellation state

Declaration

[ActionProperty("Test is source case is canceled", null)]
public bool SourceCaseCancellation { get; }

Property Value

Type	Description
bool

SourceCaseCancellationDate

Get the source case cancellation date

Declaration

[ActionProperty("Source case cancellation date", null)]
public DateTime? SourceCaseCancellationDate { get; }

Property Value

Type	Description
DateTime?

SourceCaseName

Gets the name of the source case

Declaration

[ActionProperty("Source case name", null)]
public string SourceCaseName { get; }

Property Value

Type	Description
string

SourceCaseSlot

Gets the source case slot

Declaration

[ActionProperty("Source case slot", null)]
public string SourceCaseSlot { get; }

Property Value

Type	Description
string

SourceEnd

Get end date of the source case value by the case field name

Declaration

public ScriptDictionary<string, DateTime?> SourceEnd { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

SourcePayrollValue

Gets the source case field value wrapped as PayrollValue, indexed by field name

Declaration

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

Property Value

Type	Description
ScriptDictionary<string, PayrollValue>

SourceStart

Get start date of the source case value by the case field name

Declaration

public ScriptDictionary<string, DateTime?> SourceStart { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

SourceValue

Get source case value by the case field name

Declaration

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

Property Value

Type	Description
ScriptDictionary<string, object>

TargetCaseCancellation

Get the target cancellation state

Declaration

[ActionProperty("Test if target case is canceled", null)]
public bool TargetCaseCancellation { get; }

Property Value

Type	Description
bool

TargetCaseCancellationDate

Get the target case cancellation date

Declaration

[ActionProperty("Target case cancellation date", null)]
public DateTime? TargetCaseCancellationDate { get; }

Property Value

Type	Description
DateTime?

TargetCaseName

Gets the name of the target case

Declaration

[ActionProperty("Target case name", null)]
public string TargetCaseName { get; }

Property Value

Type	Description
string

TargetCaseSlot

Gets the target case slot

Declaration

[ActionProperty("Target case slot", null)]
public string TargetCaseSlot { get; }

Property Value

Type	Description
string

TargetEnd

Get or set end date of the target case value by the case field name

Declaration

public ScriptDictionary<string, DateTime?> TargetEnd { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

TargetPayrollValue

Get or set target case PayrollValue by the case field name

Declaration

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

Property Value

Type	Description
ScriptDictionary<string, PayrollValue>

TargetStart

Get or set the start date of the target case value by the case field name

Declaration

public ScriptDictionary<string, DateTime?> TargetStart { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

TargetValue

Get or set target case value by the case field name

Declaration

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

Property Value

Type	Description
ScriptDictionary<string, object>

Methods

CopyEnd(string, string)

Copies the case field end date from source to target, overwriting any existing value

Declaration

public void CopyEnd(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

CopyStart(string, string)

Copies the case field start date from source to target, overwriting any existing value

Declaration

public void CopyStart(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

CopyValue(string, string)

Copies the case value from source to target, overwriting any existing value

Declaration

public void CopyValue(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

GetSourceCaseAttribute(string)

Get source case attribute value

Declaration

public object GetSourceCaseAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName	The attribute name

Returns

Type	Description
object

GetSourceCaseAttribute<T>(string, T)

Gets a source case attribute as a typed value

Declaration

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

Parameters

Type	Name	Description
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetSourceCaseFieldAttribute(string, string)

Get source case field attribute value

Declaration

public object GetSourceCaseFieldAttribute(string caseFieldName, string attributeName)

Parameters

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

Returns

Type	Description
object

GetSourceCaseFieldAttribute<T>(string, string, T)

Get source case field attribute typed value

Declaration

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

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetSourceCaseValueAttribute(string, string)

Get source case value attribute value

Declaration

public object GetSourceCaseValueAttribute(string caseFieldName, string attributeName)

Parameters

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

Returns

Type	Description
object

GetSourceCaseValueAttribute<T>(string, string, T)

Get source case value attribute typed value

Declaration

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

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetSourceEnd(string)

Get end date of the source case value by the case field name

Declaration

public DateTime? GetSourceEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DateTime?

GetSourceFieldNames()

Get source field names

Declaration

public string[] GetSourceFieldNames()

Returns

Type	Description
string[]

GetSourcePayrollValue(string)

Get source case field PayrollValue by the case field name

Declaration

public PayrollValue GetSourcePayrollValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
PayrollValue

GetSourcePeriod(string)

Get period of a source case field

Declaration

public DatePeriod GetSourcePeriod(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DatePeriod

GetSourceStart(string)

Get the start date of a case field

Declaration

public DateTime? GetSourceStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DateTime?

GetSourceValue(string)

Get source case value by the case field name

Declaration

public object GetSourceValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
object

GetSourceValue(string, object)

Get source case value by the case field name with a default value

Declaration

public object GetSourceValue(string caseFieldName, object defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
object	defaultValue	The default value

Returns

Type	Description
object

GetSourceValueType(string)

Get the source case value type

Declaration

public ValueType GetSourceValueType(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
ValueType

GetSourceValue<T>(string)

Get source case field typed value by the case field name

Declaration

public T GetSourceValue<T>(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetSourceValue<T>(string, T)

Get source case field typed value by the case field name with a default value

Declaration

public T GetSourceValue<T>(string caseFieldName, T defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetTargetCaseAttribute(string)

Get target case attribute value

Declaration

public object GetTargetCaseAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName

Returns

Type	Description
object

GetTargetCaseAttribute<T>(string, T)

Gets a target case attribute as a typed value

Declaration

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

Parameters

Type	Name	Description
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetTargetCaseFieldAttribute(string, string)

Get target case field attribute value

Declaration

public object GetTargetCaseFieldAttribute(string caseFieldName, string attributeName)

Parameters

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

Returns

Type	Description
object

GetTargetCaseFieldAttribute<T>(string, string, T)

Get target case field attribute typed value

Declaration

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

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetTargetCaseValueAttribute(string, string)

Get target case value attribute value

Declaration

public object GetTargetCaseValueAttribute(string caseFieldName, string attributeName)

Parameters

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

Returns

Type	Description
object

GetTargetCaseValueAttribute<T>(string, string, T)

Get target case value attribute typed value

Declaration

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

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetTargetEnd(string)

Get end date of the target case value by the case field name

Declaration

public DateTime? GetTargetEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DateTime?

GetTargetFieldNames()

Get target field names

Declaration

public string[] GetTargetFieldNames()

Returns

Type	Description
string[]

GetTargetPayrollValue(string)

Get target case value by the case field name

Declaration

public PayrollValue GetTargetPayrollValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
PayrollValue

GetTargetPeriod(string)

Get period of a target case field

Declaration

public DatePeriod GetTargetPeriod(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DatePeriod

GetTargetStart(string)

Get the start date of the target case value by the case field name

Declaration

public DateTime? GetTargetStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DateTime?

GetTargetValue(string)

Get target case value by the case field name

Declaration

public object GetTargetValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
object

GetTargetValue(string, object)

Get target case value by the case field name with a default value

Declaration

public object GetTargetValue(string caseFieldName, object defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
object	defaultValue	The default value

Returns

Type	Description
object

GetTargetValueType(string)

Get the target case value type

Declaration

public ValueType GetTargetValueType(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
ValueType

GetTargetValue<T>(string)

Get target case typed value by the case field name

Declaration

public T GetTargetValue<T>(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetTargetValue<T>(string, T)

Get target case typed value by the case field name

Declaration

public T GetTargetValue<T>(string caseFieldName, T defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
T	defaultValue	The default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

HasSourceEnd(string)

Test if source case field end is defined

Declaration

public bool HasSourceEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasSourceField(string)

Test if a source case field is defined

Declaration

public bool HasSourceField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasSourceFields()

Test if the source case contains fields

Declaration

public bool HasSourceFields()

Returns

Type	Description
bool

HasSourceStart(string)

Test if source case field start is defined

Declaration

public bool HasSourceStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasSourceValue(string)

Test if a source case value is defined

Declaration

public bool HasSourceValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasTargetEnd(string)

Test if target case field end is defined

Declaration

public bool HasTargetEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasTargetField(string)

Test if a target case field is defined

Declaration

public bool HasTargetField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasTargetFields()

Test if the target case contains fields

Declaration

public bool HasTargetFields()

Returns

Type	Description
bool

HasTargetStart(string)

Test if target case field start is defined

Declaration

public bool HasTargetStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

HasTargetValue(string)

Test if a target case value is defined

Declaration

public bool HasTargetValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

InitEnd(string, string)

Sets the target case field end date from the source case field, only if no end date is currently set on the target

Declaration

public void InitEnd(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

Remarks

Use CopyEnd(string, string) to overwrite unconditionally.

InitStart(string, string)

Sets the target case field start date from the source case field, only if no start date is currently set on the target

Declaration

public void InitStart(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

Remarks

Use CopyStart(string, string) to overwrite unconditionally.

InitTargetEnd(string, DateTime?)

Initialize the target end

Declaration

public void InitTargetEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
DateTime?	end	The end date

InitTargetStart(string, DateTime?)

Initialize the target start

Declaration

public void InitTargetStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
DateTime?	start	The start date

InitTargetValue(string, object)

Initialize the target value

Declaration

public void InitTargetValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
object	value	The target init value

InitValue(string, string)

Sets the target case value from the source case field, only if no value is currently set on the target

Declaration

public void InitValue(string sourceFieldName, string targetFieldName)

Parameters

Type	Name	Description
string	sourceFieldName	The source case field name
string	targetFieldName	The target case field name

Remarks

Use CopyValue(string, string) to overwrite unconditionally.

IsSourceFieldComplete(string)

Test if a source case field is complete

Declaration

public bool IsSourceFieldComplete(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

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 case field name

Returns

Type	Description
bool

IsTargetFieldComplete(string)

Test if a target case field is complete

Declaration

public bool IsTargetFieldComplete(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

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 case field name

Returns

Type	Description
bool

SetTargetEnd(string, DateTime?)

Set the end date of the target case value by the case field name

Declaration

public void SetTargetEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
DateTime?	end	The end date

SetTargetPayrollValue(string, PayrollValue)

Sets the target case value from a PayrollValue

Declaration

public void SetTargetPayrollValue(string caseFieldName, PayrollValue value)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
PayrollValue	value	The payroll value to write

SetTargetStart(string, DateTime?)

Set the start date of the target case value by the case field name

Declaration

public void SetTargetStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
DateTime?	start	The start date

SetTargetValue(string, object)

Set target case value by the case field name

Declaration

public void SetTargetValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
object	value	The target value

SourceValueContainsCsvToken(string, string)

Test a string source case value containing a csv token

Declaration

public bool SourceValueContainsCsvToken(string caseFieldName, string token)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	token	The token to search

Returns

Type	Description
bool

SourceValueEquals<T>(string, T)

Test a source case value

Declaration

public bool SourceValueEquals<T>(string caseFieldName, T testValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
T	testValue	The value to test

Returns

Type	Description
bool

Type Parameters

Name	Description
T

SourceValueIsWithin(string, decimal, decimal)

Test if a decimal source case value is within a range

Declaration

public bool SourceValueIsWithin(string caseFieldName, decimal min, decimal max)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
decimal	min	The minimum value
decimal	max	The maximum value

Returns

Type	Description
bool

SourceValueIsWithin(string, int, int)

Test if an integer source case value is within a range

Declaration

public bool SourceValueIsWithin(string caseFieldName, int min, int max)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
int	min	The minimum value
int	max	The maximum value

Returns

Type	Description
bool

TargetFieldAvailable(string)

Test if a target case field is available

Declaration

public bool TargetFieldAvailable(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

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 case field name
bool	available	Target field available state

TargetValueContainsCsvToken(string, string)

Test if a string target case value for a csv separated token

Declaration

public bool TargetValueContainsCsvToken(string caseFieldName, string token)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	token	The token to search

Returns

Type	Description
bool

TargetValueEquals<T>(string, T)

Test a target case value

Declaration

public bool TargetValueEquals<T>(string caseFieldName, T testValue)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
T	testValue	The value to test

Returns

Type	Description
bool

Type Parameters

Name	Description
T

TargetValueHasSourceSlotCsvToken(string)

Tests whether a target case field's CSV value contains the current source case slot identifier

Declaration

public bool TargetValueHasSourceSlotCsvToken(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool

TargetValueIsWithin(string, decimal, decimal)

Test if a decimal target case value is within a range

Declaration

public bool TargetValueIsWithin(string caseFieldName, decimal min, decimal max)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
decimal	min	The minimum value
decimal	max	The maximum value

Returns

Type	Description
bool

TargetValueIsWithin(string, int, int)

Test if an integer target case value is within a range

Declaration

public bool TargetValueIsWithin(string caseFieldName, int min, int max)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
int	min	The minimum value
int	max	The maximum value

Returns

Type	Description
bool

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)