Class PayrunJobInvocation

The payrun job client object

Inheritance

object

PayrunJobInvocation

Implements

IPayrunJobInvocation

IEquatable<IPayrunJobInvocation>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

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 PayrunJobInvocation : IPayrunJobInvocation, IEquatable<IPayrunJobInvocation>

Constructors

PayrunJobInvocation()

Initializes a new instance

Declaration

public PayrunJobInvocation()

PayrunJobInvocation(PayrunJobInvocation)

Initializes a new instance from a copy

Declaration

public PayrunJobInvocation(PayrunJobInvocation copySource)

Parameters

Type	Name	Description
PayrunJobInvocation	copySource	The copy source

Properties

Attributes

Payrun job attributes

Declaration

public Dictionary<string, object> Attributes { get; set; }

Property Value

Type	Description
Dictionary<string, object>

CompletedJobStatus

The completed payrun job status, used by test runner to bypass the manual workflow. If set, the background processor finalizes the job with this status instead of leaving it in Draft. Null (default) means the job stays in Draft after calculation, following the normal workflow.

Declaration

public PayrunJobStatus? CompletedJobStatus { get; set; }

Property Value

Type	Description
PayrunJobStatus?

EmployeeIdentifiers

The payrun employee identifiers

Declaration

public List<string> EmployeeIdentifiers { get; set; }

Property Value

Type	Description
List<string>

EvaluationDate

The evaluation date (immutable)

Declaration

public DateTime? EvaluationDate { get; set; }

Property Value

Type	Description
DateTime?

Forecast

The forecast name (immutable)

Declaration

public string Forecast { get; set; }

Property Value

Type	Description
string

JobResult

The payrun job result

Declaration

public PayrunJobResult JobResult { get; set; }

Property Value

Type	Description
PayrunJobResult

JobStatus

The target payrun job status

Declaration

public PayrunJobStatus JobStatus { get; set; }

Property Value

Type	Description
PayrunJobStatus

LogLevel

The function log level, default is information

Declaration

public LogLevel LogLevel { get; set; }

Property Value

Type	Description
LogLevel

Name

The job name (immutable)

Declaration

[Required]
public string Name { get; set; }

Property Value

Type	Description
string

Owner

The job owner (immutable)

Declaration

public string Owner { get; set; }

Property Value

Type	Description
string

ParentJobId

The parent payrun job id, e.g. the parent retro pay run job (immutable)

Declaration

public int? ParentJobId { get; set; }

Property Value

Type	Description
int?

PayrunJobId

The payrun job id (immutable)

Declaration

public int? PayrunJobId { get; set; }

Property Value

Type	Description
int?

PayrunName

The payrun name (immutable)

Declaration

[Required]
public string PayrunName { get; set; }

Property Value

Type	Description
string

PeriodStart

The period start date (immutable)

Declaration

[Required]
public DateTime PeriodStart { get; set; }

Property Value

Type	Description
DateTime

Reason

The execution reason (immutable)

Declaration

[Required]
public string Reason { get; set; }

Property Value

Type	Description
string

RetroJobs

The retro payrun jobs, requires the ParentJobId (immutable)

Declaration

public List<RetroPayrunJob> RetroJobs { get; set; }

Property Value

Type	Description
List<RetroPayrunJob>

RetroPayMode

The payrun retro pay mode (immutable)

Declaration

public RetroPayMode RetroPayMode { get; set; }

Property Value

Type	Description
RetroPayMode

StoreEmptyResults

Store empty employee results (default: false)

Declaration

public bool StoreEmptyResults { get; set; }

Property Value

Type	Description
bool

Tags

The job tags (immutable)

Declaration

public List<string> Tags { get; set; }

Property Value

Type	Description
List<string>

UserIdentifier

The user identifier (immutable)

Declaration

[Required]
public string UserIdentifier { get; set; }

Property Value

Type	Description
string

Methods

Equals(IPayrunJobInvocation)

Declaration

public virtual bool Equals(IPayrunJobInvocation compare)

Parameters

Type	Name	Description
IPayrunJobInvocation	compare

Returns

Type	Description
bool

Implements

IPayrunJobInvocation

IEquatable<T>

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)