Class Report

The payroll report client object

Inheritance

object

ModelBase

Report

ReportSet

Implements

IReport

IModel

IAttributeObject

IKeyEquatable<IReport>

IEquatable<IReport>

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 Report : ModelBase, IReport, IModel, IAttributeObject, IKeyEquatable<IReport>, IEquatable<IReport>, INameObject

Constructors

Report()

Initializes a new instance

Declaration

public Report()

Report(Report)

Initializes a new instance from a copy

Declaration

public Report(Report copySource)

Parameters

Type	Name	Description
Report	copySource	The copy source

Properties

AttributeMode

The report attribute mode

Declaration

[JsonPropertyOrder(105)]
public ReportAttributeMode AttributeMode { get; set; }

Property Value

Type	Description
ReportAttributeMode

Attributes

Declaration

[JsonPropertyOrder(117)]
public Dictionary<string, object> Attributes { get; set; }

Property Value

Type	Description
Dictionary<string, object>

BuildExpression

The report build expression

Declaration

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

Property Value

Type	Description
string

BuildExpressionFile

The report build expression file

Declaration

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

Property Value

Type	Description
string

Category

The report category

Declaration

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

Property Value

Type	Description
string

Clusters

The report clusters

Declaration

[JsonPropertyOrder(116)]
public List<string> Clusters { get; set; }

Property Value

Type	Description
List<string>

Description

The payroll result report description

Declaration

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

Property Value

Type	Description
string

DescriptionLocalizations

The localized payroll result report descriptions

Declaration

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

Property Value

Type	Description
Dictionary<string, string>

EndExpression

The report end expression

Declaration

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

Property Value

Type	Description
string

EndExpressionFile

The report end expression file

Declaration

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

Property Value

Type	Description
string

Name

The report name

Declaration

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

Property Value

Type	Description
string

NameLocalizations

The localized payroll result report names

Declaration

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

Property Value

Type	Description
Dictionary<string, string>

OverrideType

The override type

Declaration

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

Property Value

Type	Description
OverrideType

Queries

The report queries, key is the query name and value the api operation name

Declaration

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

Property Value

Type	Description
Dictionary<string, string>

Relations

The report data relations, based on the queries

Declaration

[JsonPropertyOrder(115)]
public List<DataRelation> Relations { get; set; }

Property Value

Type	Description
List<DataRelation>

StartExpression

The report start expression

Declaration

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

Property Value

Type	Description
string

StartExpressionFile

The report start expression file

Declaration

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

Property Value

Type	Description
string

UserType

The user type (default: employee)

Declaration

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

Property Value

Type	Description
UserType

Methods

EqualKey(IReport)

Test for the same item key

Declaration

public virtual bool EqualKey(IReport compare)

Parameters

Type	Name	Description
IReport	compare

Returns

Type	Description
bool

Equals(IReport)

Declaration

public virtual bool Equals(IReport compare)

Parameters

Type	Name	Description
IReport	compare

Returns

Type	Description
bool

GetUiString()

The object UI string

Declaration

public override string GetUiString()

Returns

Type	Description
string

Overrides

ModelBase.GetUiString()

Implements

IReport

IModel

IAttributeObject

IKeyEquatable<T>

IEquatable<T>

INameObject

Extension Methods

ScriptExtensions.HasAnyScript(Report)

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)