Class Collector
The payroll collector client object
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class Collector : ModelBase, ICollector, IModel, IAttributeObject, IKeyEquatable<ICollector>, IEquatable<ICollector>, INameObject
Constructors
Collector()
Initializes a new instance
Declaration
Collector(Collector)
Initializes a new instance from a copy
Declaration
public Collector(Collector copySource)
Parameters
| Type |
Name |
Description |
| Collector |
copySource |
The copy source
|
Properties
ApplyActions
The collector apply actions
Declaration
[JsonPropertyOrder(118)]
public List<string> ApplyActions { get; set; }
Property Value
ApplyExpression
Expression used while applying a value to the collector
Declaration
[JsonPropertyOrder(113)]
public string ApplyExpression { get; set; }
Property Value
ApplyExpressionFile
Expression used while applying a value to the collector file
Declaration
[JsonPropertyOrder(114)]
public string ApplyExpressionFile { get; set; }
Property Value
Attributes
Declaration
[JsonPropertyOrder(121)]
public Dictionary<string, object> Attributes { get; set; }
Property Value
Clusters
Declaration
[JsonPropertyOrder(120)]
public List<string> Clusters { get; set; }
Property Value
CollectMode
The collect mode (immutable, default: summary)
Declaration
[JsonPropertyOrder(102)]
public CollectMode CollectMode { get; set; }
Property Value
CollectorGroups
Associated collector groups
Declaration
[JsonPropertyOrder(107)]
public List<string> CollectorGroups { get; set; }
Property Value
Culture
The collector culture name based on RFC 4646
Declaration
[JsonPropertyOrder(106)]
public string Culture { get; set; }
Property Value
EndActions
The collector end actions
Declaration
[JsonPropertyOrder(119)]
public List<string> EndActions { get; set; }
Property Value
EndExpression
Expression used while the collector is ended
Declaration
[JsonPropertyOrder(115)]
public string EndExpression { get; set; }
Property Value
EndExpressionFile
Expression used while the collector is ended file
Declaration
[JsonPropertyOrder(116)]
public string EndExpressionFile { get; set; }
Property Value
MaxResult
The maximum allowed value
Declaration
[JsonPropertyOrder(110)]
public decimal? MaxResult { get; set; }
Property Value
MinResult
The minimum allowed value
Declaration
[JsonPropertyOrder(109)]
public decimal? MinResult { get; set; }
Property Value
Name
Declaration
[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }
Property Value
NameLocalizations
The localized collector names
Declaration
[JsonPropertyOrder(101)]
public Dictionary<string, string> NameLocalizations { get; set; }
Property Value
Negated
Negated collector result (immutable, default: false)
Declaration
[JsonPropertyOrder(103)]
public bool Negated { get; set; }
Property Value
OverrideType
Declaration
[JsonPropertyOrder(104)]
public OverrideType OverrideType { get; set; }
Property Value
StartActions
The collector start actions
Declaration
[JsonPropertyOrder(117)]
public List<string> StartActions { get; set; }
Property Value
StartExpression
Expression used while the collector is started
Declaration
[JsonPropertyOrder(111)]
public string StartExpression { get; set; }
Property Value
StartExpressionFile
Expression used while the collector is started file
Declaration
[JsonPropertyOrder(112)]
public string StartExpressionFile { get; set; }
Property Value
Threshold
Declaration
[JsonPropertyOrder(108)]
public decimal? Threshold { get; set; }
Property Value
ValueType
The value type, default is value type money
Declaration
[JsonPropertyOrder(105)]
public ValueType ValueType { get; set; }
Property Value
Methods
EqualKey(ICollector)
Test for the same item key
Declaration
public virtual bool EqualKey(ICollector compare)
Parameters
Returns
Equals(ICollector)
Declaration
public virtual bool Equals(ICollector compare)
Parameters
Returns
GetUiString()
Declaration
public override string GetUiString()
Returns
Overrides
Implements
Extension Methods