Show / Hide Table of Contents

Class ModelBase

Base for all Payroll models

Inheritance
object
ModelBase
Calendar
Case
CaseChange
CaseChangeSetup
CaseDocument
CaseField
CaseRelation
CaseSetup
CaseValue
Collector
CollectorCustomResult
CollectorResult
Division
Employee
Log
Lookup
LookupValue
Payroll
PayrollLayer
PayrollResult
Payrun
PayrunJob
PayrunJobEmployee
PayrunParameter
PayrunResult
Regulation
RegulationShare
Report
ReportLog
ReportParameter
ReportTemplate
Script
Task
Tenant
User
WageType
WageTypeCustomResult
WageTypeResult
Webhook
WebhookMessage
Implements
IModel
Inherited Members
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 abstract class ModelBase : IModel
Remarks

JSON property order range from 0 to 99

Constructors

ModelBase()

Initializes a new instance

Declaration
protected ModelBase()

ModelBase(ModelBase)

Initializes a new instance from a copy

Declaration
protected ModelBase(ModelBase copySource)
Parameters
Type Name Description
ModelBase copySource

The copy source

Properties

Created

The date which the client object was created (immutable)

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

Id

The unique object id (immutable)

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

IsExistingObject

Test for existing object (opposite of IsNewObject)

Declaration
[JsonIgnore]
public bool IsExistingObject { get; }
Property Value
Type Description
bool

IsNewObject

Test for new object (opposite of IsExistingObject)

Declaration
[JsonIgnore]
public bool IsNewObject { get; }
Property Value
Type Description
bool

Status

The status of the object

Declaration
[JsonPropertyOrder(1002)]
public ObjectStatus Status { get; set; }
Property Value
Type Description
ObjectStatus

UpdateMode

The object update mode

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

Updated

The date which the client object was last updated (immutable)

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

Methods

GetUiString()

The object UI string

Declaration
public abstract string GetUiString()
Returns
Type Description
string

ToString()

Returns a string that represents this instance

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance

Overrides
object.ToString()

Implements

IModel

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