Show / Hide Table of Contents

Class Payroll

The payroll client object

Inheritance
object
ModelBase
Payroll
PayrollSet
Implements
IPayroll
IModel
IAttributeObject
IKeyEquatable<IPayroll>
IEquatable<IPayroll>
INameObject
Inherited Members
ModelBase.ToString()
ModelBase.Id
ModelBase.IsExistingObject
ModelBase.IsNewObject
ModelBase.Status
ModelBase.Created
ModelBase.Updated
ModelBase.UpdateMode
object.GetType()
object.MemberwiseClone()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class Payroll : ModelBase, IPayroll, IModel, IAttributeObject, IKeyEquatable<IPayroll>, IEquatable<IPayroll>, INameObject

Constructors

Payroll()

Initializes a new instance

Declaration
public Payroll()

Payroll(Payroll)

Initializes a new instance from a copy

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

The copy source

Properties

Attributes

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

ClusterSetCase

The case cluster set (undefined: all)

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

ClusterSetCaseField

The case field cluster set (undefined: all)

Declaration
[StringLength(128)]
[JsonPropertyOrder(107)]
public string ClusterSetCaseField { get; set; }
Property Value
Type Description
string

ClusterSetCaseValue

The case value cluster set (undefined: none, *: all)

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

ClusterSetCollector

The collector cluster set (undefined: all)

Declaration
[StringLength(128)]
[JsonPropertyOrder(108)]
public string ClusterSetCollector { get; set; }
Property Value
Type Description
string

ClusterSetCollectorRetro

The collector cluster set for retro payrun jobs (undefined: all)

Declaration
[StringLength(128)]
[JsonPropertyOrder(109)]
public string ClusterSetCollectorRetro { get; set; }
Property Value
Type Description
string

ClusterSetWageType

The wage type cluster set (undefined: all)

Declaration
[StringLength(128)]
[JsonPropertyOrder(110)]
public string ClusterSetWageType { get; set; }
Property Value
Type Description
string

ClusterSetWageTypePeriod

The wage type period result cluster set (undefined: none)

Declaration
[StringLength(128)]
[JsonPropertyOrder(113)]
public string ClusterSetWageTypePeriod { get; set; }
Property Value
Type Description
string

ClusterSetWageTypeRetro

The wage type cluster set for retro payrun jobs (undefined: all)

Declaration
[StringLength(128)]
[JsonPropertyOrder(111)]
public string ClusterSetWageTypeRetro { get; set; }
Property Value
Type Description
string

ClusterSets

Cluster sets

Declaration
[JsonPropertyOrder(114)]
public List<ClusterSet> ClusterSets { get; set; }
Property Value
Type Description
List<ClusterSet>

Description

Payroll description

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

DescriptionLocalizations

The localized payroll descriptions

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

DivisionId

The division id

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

DivisionName

The division name (client only)

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

Name

The payroll name

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

NameLocalizations

The localized payroll names

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

Methods

EqualKey(IPayroll)

Test for the same item key

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

Equals(IPayroll)

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

GetUiString()

The object UI string

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

Implements

IPayroll
IModel
IAttributeObject
IKeyEquatable<T>
IEquatable<T>
INameObject

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)
ValueTypeExtensions.GetValueType(object)
ObjectInfo.GetPropertyValue(object, string)
ObjectInfo.GetPropertyValue<T>(object, string, T)
ObjectInfo.ResolvePropertyValue(object, string)
ObjectInfo.SetPropertyValue(object, string, object)
☀
☾
Back to top Generated by DocFX