Class CollectorResult

The collector result client object

Inheritance
object
ModelBase
CollectorResult
CollectorResultSet
Implements
Inherited Members
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class CollectorResult : ModelBase, ICollectorResult, IModel, IAttributeObject, IEquatable<ICollectorResult>, INumericValueResult

Constructors

CollectorResult()

Initializes a new instance

Declaration
public CollectorResult()

CollectorResult(CollectorResult)

Initializes a new instance from a copy

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

The copy source

Properties

Attributes

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

CollectMode

The collect mode (immutable)

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

CollectorId

The collector id (immutable)

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

CollectorName

The collector name (immutable)

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

CollectorNameLocalizations

The localized collector names (immutable)

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

Culture

The collector result culture name based on RFC 4646

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

End

The ending date for the value (immutable)

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

Negated

Negated collector result (immutable)

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

PayrollResultId

The payroll result id (immutable)

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

Start

The starting date for the value (immutable)

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

Tags

The result tags

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

Value

The collector custom result value (immutable)

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

Nullable for tests

ValueType

The value type (immutable)

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

Methods

AlmostEqualValue(decimal?, int)

Test if value is almost equal value using a test precision

Declaration
public virtual bool AlmostEqualValue(decimal? compare, int precision)
Parameters
Type Name Description
decimal? compare

The value to compare
int precision

The test precision
Returns
Type Description
bool

True for almost equal values

Equals(ICollectorResult)

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

GetUiString()

The object UI string

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

ToString()

Returns a string that represents this instance

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance
Overrides

Implements

Extension Methods