Class CaseField

The payroll case field client object

Inheritance
object
ModelBase
CaseField
CaseFieldSet
Implements
Inherited Members
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class CaseField : ModelBase, ICaseField, IModel, IAttributeObject, IKeyEquatable<ICaseField>, IEquatable<ICaseField>, INameObject

Constructors

CaseField()

Initializes a new instance

Declaration
public CaseField()

CaseField(CaseField)

Initializes a new instance from a copy

Declaration
public CaseField(CaseField copySource)
Parameters
Type Name Description
CaseField copySource

The copy source

Properties

Attributes

Declaration
[JsonPropertyOrder(126)]
public Dictionary<string, object> Attributes { get; set; }
Property Value
Type Description
Dictionary<string, object>

CancellationMode

The cancellation mode

Declaration
[JsonPropertyOrder(110)]
public CaseFieldCancellationMode CancellationMode { get; set; }
Property Value
Type Description
CaseFieldCancellationMode

Clusters

The case field clusters

Declaration
[JsonPropertyOrder(123)]
public List<string> Clusters { get; set; }
Property Value
Type Description
List<string>

Culture

The case field culture name based on RFC 4646

Declaration
[JsonPropertyOrder(112)]
public string Culture { get; set; }
Property Value
Type Description
string

DefaultEnd

The default end value of the case field (date or expression)

Declaration
[JsonPropertyOrder(119)]
public string DefaultEnd { get; set; }
Property Value
Type Description
string

DefaultStart

The default start value of the case field (date or expression)

Declaration
[JsonPropertyOrder(118)]
public string DefaultStart { get; set; }
Property Value
Type Description
string

DefaultValue

The default value of the case field (JSON format)

Declaration
[JsonPropertyOrder(120)]
public string DefaultValue { get; set; }
Property Value
Type Description
string

Description

The case field description

Declaration
[JsonPropertyOrder(102)]
public string Description { get; set; }
Property Value
Type Description
string

DescriptionLocalizations

The localized case field descriptions

Declaration
[JsonPropertyOrder(103)]
public Dictionary<string, string> DescriptionLocalizations { get; set; }
Property Value
Type Description
Dictionary<string, string>

EndDateType

The end date type

Declaration
[JsonPropertyOrder(116)]
public CaseFieldDateType EndDateType { get; set; }
Property Value
Type Description
CaseFieldDateType

EndMandatory

The end date mandatory state

Declaration
[JsonPropertyOrder(117)]
public bool EndMandatory { get; set; }
Property Value
Type Description
bool

LookupSettings

The lookup settings

Declaration
[JsonPropertyOrder(122)]
public LookupSettings LookupSettings { get; set; }
Property Value
Type Description
LookupSettings

Name

The case field name

Declaration
[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }
Property Value
Type Description
string

NameLocalizations

The localized case field names

Declaration
[JsonPropertyOrder(101)]
public Dictionary<string, string> NameLocalizations { get; set; }
Property Value
Type Description
Dictionary<string, string>

Order

The case field order

Declaration
[JsonPropertyOrder(114)]
public int Order { get; set; }
Property Value
Type Description
int

OverrideType

The override type

Declaration
[JsonPropertyOrder(109)]
public OverrideType OverrideType { get; set; }
Property Value
Type Description
OverrideType

PeriodAggregation

The period aggregation type for Period

Declaration
[JsonPropertyOrder(108)]
public CaseFieldAggregationType PeriodAggregation { get; set; }
Property Value
Type Description
CaseFieldAggregationType

StartDateType

The start date type

Declaration
[JsonPropertyOrder(115)]
public CaseFieldDateType StartDateType { get; set; }
Property Value
Type Description
CaseFieldDateType

Tags

The case field tags

Declaration
[JsonPropertyOrder(121)]
public List<string> Tags { get; set; }
Property Value
Type Description
List<string>

TimeType

The date period type

Declaration
[JsonPropertyOrder(106)]
public CaseFieldTimeType TimeType { get; set; }
Property Value
Type Description
CaseFieldTimeType

TimeUnit

The date unit type

Declaration
[JsonPropertyOrder(107)]
public CaseFieldTimeUnit TimeUnit { get; set; }
Property Value
Type Description
CaseFieldTimeUnit

ValueAttributes

Custom value attributes

Declaration
[JsonPropertyOrder(127)]
public Dictionary<string, object> ValueAttributes { get; set; }
Property Value
Type Description
Dictionary<string, object>

ValueCreationMode

The case value creation mode

Declaration
[JsonPropertyOrder(111)]
public CaseValueCreationMode ValueCreationMode { get; set; }
Property Value
Type Description
CaseValueCreationMode

ValueMandatory

Mandatory case field value

Declaration
[JsonPropertyOrder(113)]
public bool ValueMandatory { get; set; }
Property Value
Type Description
bool

ValueScope

The value scope

Declaration
[JsonPropertyOrder(105)]
public ValueScope ValueScope { get; set; }
Property Value
Type Description
ValueScope

ValueType

The value type of the case field

Declaration
[JsonPropertyOrder(104)]
public ValueType ValueType { get; set; }
Property Value
Type Description
ValueType

Methods

EqualKey(ICaseField)

Test for the same item key

Declaration
public virtual bool EqualKey(ICaseField compare)
Parameters
Type Name Description
ICaseField compare
Returns
Type Description
bool

Equals(ICaseField)

Declaration
public virtual bool Equals(ICaseField compare)
Parameters
Type Name Description
ICaseField compare
Returns
Type Description
bool

GetUiString()

The object UI string

Declaration
public override string GetUiString()
Returns
Type Description
string
Overrides

Implements

Extension Methods