Class CaseValue
National, company or employee case value
Implements
Inherited Members
Namespace: PayrollEngine.Client.Scripting
Assembly: PayrollEngine.Client.Scripting.dll
Syntax
public class CaseValue : IEquatable<CaseValue>
Constructors
View SourceCaseValue()
Initializes a new instance
Declaration
public CaseValue()
CaseValue(CaseValue)
Initializes a new instance from a copy
Declaration
public CaseValue(CaseValue copySource)
Parameters
| Type | Name | Description |
|---|---|---|
| CaseValue | copySource | The copy source |
Remarks
Deep copies Tags and Attributes to prevent shared-reference mutations.
CaseValue(string, DateTime, DateTime?, DateTime?, PayrollValue, DateTime?, List<string>, Dictionary<string, object>)
Initializes a new instance
Declaration
public CaseValue(string caseFieldName, DateTime created, DateTime? start, DateTime? end, PayrollValue value, DateTime? cancellationDate = null, List<string> tags = null, Dictionary<string, object> attributes = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | caseFieldName | The case field name |
| DateTime | created | The created date |
| DateTime? | start | The start date |
| DateTime? | end | The end date |
| PayrollValue | value | The value |
| DateTime? | cancellationDate | Cancellation date |
| List<string> | tags | The tags |
| Dictionary<string, object> | attributes | The attributes |
Properties
View SourceAttributes
The attributes
Declaration
public Dictionary<string, object> Attributes { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<string, object> |
CancellationDate
Cancellation date
Declaration
public DateTime? CancellationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? |
CaseFieldName
The case field name
Declaration
public string CaseFieldName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Created
The created date
Declaration
public DateTime Created { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
End
The period end date
Declaration
public DateTime? End { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? |
Start
The period start date
Declaration
public DateTime? Start { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? |
Tags
The tags
Declaration
public List<string> Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> |
Value
The case period value as JSON
Declaration
public PayrollValue Value { get; }
Property Value
| Type | Description |
|---|---|
| PayrollValue |
Methods
View SourceEquals(CaseValue)
Compare two objects
Declaration
public bool Equals(CaseValue compare)
Parameters
| Type | Name | Description |
|---|---|---|
| CaseValue | compare | The object to compare with this |
Returns
| Type | Description |
|---|---|
| bool | True for objects with the same data |
ToString()
Returns a string that represents this instance
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | A string that represents this instance |