Class CaseRelationFunction

Base class for case relation functions

Inheritance
object
Function
PayrollFunction
CaseRelationFunction
CaseRelationBuildFunction
CaseRelationValidateFunction
Implements
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function
Assembly: PayrollEngine.Client.Scripting.dll
Syntax
public abstract class CaseRelationFunction : PayrollFunction, IDisposable

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

Get source case field PayrollValue by the case 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)

Copy the case field end date from source to target

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

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
string targetFieldName

CopyValue(string, string)

Copy the case value from source to target

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

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)

Get attribute 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)

Get attribute value

Declaration
public T GetTargetCaseAttribute<T>(string attributeName, T defaultValue = default)
Parameters
Type Name Description
string attributeName
T defaultValue
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)

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
string targetFieldName

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
string targetFieldName

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)

Initializes the target case value from the source case field

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

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)

Set target case value by the case field name

Declaration
public void SetTargetPayrollValue(string caseFieldName, PayrollValue value)
Parameters
Type Name Description
string caseFieldName

The case field name
PayrollValue value

The target value

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)

Test a string target case value containing a csv token, matching the target slot

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

Extension Methods