Class Payrun

The payrun client object

Inheritance

object

ModelBase

Payrun

Implements

IPayrun

IModel

IKeyEquatable<IPayrun>

IEquatable<IPayrun>

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 Payrun : ModelBase, IPayrun, IModel, IKeyEquatable<IPayrun>, IEquatable<IPayrun>, INameObject

Constructors

Payrun()

Initializes a new instance

Declaration

public Payrun()

Payrun(Payrun)

Initializes a new instance from a copy

Declaration

public Payrun(Payrun copySource)

Parameters

Type	Name	Description
Payrun	copySource	The copy source

Properties

DefaultReason

The default payrun reason

Declaration

[JsonPropertyOrder(102)]
public string DefaultReason { get; set; }

Property Value

Type	Description
string

DefaultReasonLocalizations

The localized default payrun reasons

Declaration

[JsonPropertyOrder(103)]
public Dictionary<string, string> DefaultReasonLocalizations { get; set; }

Property Value

Type	Description
Dictionary<string, string>

EmployeeAvailableExpression

The employee available expression

Declaration

[JsonPropertyOrder(106)]
public string EmployeeAvailableExpression { get; set; }

Property Value

Type	Description
string

EmployeeAvailableExpressionFile

The employee available expression file

Declaration

[JsonPropertyOrder(107)]
public string EmployeeAvailableExpressionFile { get; set; }

Property Value

Type	Description
string

EmployeeEndExpression

The expression evaluates the employee end

Declaration

[JsonPropertyOrder(110)]
public string EmployeeEndExpression { get; set; }

Property Value

Type	Description
string

EmployeeEndExpressionFile

The expression file evaluates the employee end

Declaration

[JsonPropertyOrder(111)]
public string EmployeeEndExpressionFile { get; set; }

Property Value

Type	Description
string

EmployeeStartExpression

The expression evaluates the employee start

Declaration

[JsonPropertyOrder(108)]
public string EmployeeStartExpression { get; set; }

Property Value

Type	Description
string

EmployeeStartExpressionFile

The expression file evaluates the employee start

Declaration

[JsonPropertyOrder(109)]
public string EmployeeStartExpressionFile { get; set; }

Property Value

Type	Description
string

EndExpression

The payrun end expression

Declaration

[JsonPropertyOrder(114)]
public string EndExpression { get; set; }

Property Value

Type	Description
string

EndExpressionFile

The payrun end expression file

Declaration

[JsonPropertyOrder(115)]
public string EndExpressionFile { get; set; }

Property Value

Type	Description
string

Name

The payrun name

Declaration

[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }

Property Value

Type	Description
string

NameLocalizations

The localized payrun name

Declaration

[JsonPropertyOrder(101)]
public Dictionary<string, string> NameLocalizations { get; set; }

Property Value

Type	Description
Dictionary<string, string>

PayrollId

The payroll id (immutable)

Declaration

[JsonPropertyOrder(117)]
public int PayrollId { get; set; }

Property Value

Type	Description
int

PayrollName

The payroll name (client only)

Declaration

[Required]
[JsonPropertyOrder(118)]
public string PayrollName { get; set; }

Property Value

Type	Description
string

PayrunParameters

The payrun parameters

Declaration

[JsonPropertyOrder(100)]
public List<PayrunParameter> PayrunParameters { get; set; }

Property Value

Type	Description
List<PayrunParameter>

RetroTimeType

The payrun retro time type

Declaration

[JsonPropertyOrder(116)]
public RetroTimeType RetroTimeType { get; set; }

Property Value

Type	Description
RetroTimeType

StartExpression

The payrun start expression

Declaration

[JsonPropertyOrder(104)]
public string StartExpression { get; set; }

Property Value

Type	Description
string

StartExpressionFile

The payrun start expression file

Declaration

[JsonPropertyOrder(105)]
public string StartExpressionFile { get; set; }

Property Value

Type	Description
string

WageTypeAvailableExpression

The wage type available expression

Declaration

[JsonPropertyOrder(112)]
public string WageTypeAvailableExpression { get; set; }

Property Value

Type	Description
string

WageTypeAvailableExpressionFile

The wage type available expression file

Declaration

[JsonPropertyOrder(113)]
public string WageTypeAvailableExpressionFile { get; set; }

Property Value

Type	Description
string

Methods

EqualKey(IPayrun)

Test for the same item key

Declaration

public virtual bool EqualKey(IPayrun compare)

Parameters

Type	Name	Description
IPayrun	compare

Returns

Type	Description
bool

Equals(IPayrun)

Declaration

public virtual bool Equals(IPayrun compare)

Parameters

Type	Name	Description
IPayrun	compare

Returns

Type	Description
bool

GetUiString()

The object UI string

Declaration

public override string GetUiString()

Returns

Type	Description
string

Overrides

ModelBase.GetUiString()

Implements

IPayrun

IModel

IKeyEquatable<T>

IEquatable<T>

INameObject

Extension Methods

ScriptExtensions.HasAnyScript(Payrun)

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)