Class ReportFunctionController<TFunc, TFuncAttribute, TScriptAttribute>
Function controller
Inheritance
FunctionControllerBase<TFunc, TFuncAttribute, TScriptAttribute>
ReportFunctionController<TFunc, TFuncAttribute, TScriptAttribute>
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function.Api
Assembly: PayrollEngine.Client.Services.dll
Syntax
public abstract class ReportFunctionController<TFunc, TFuncAttribute, TScriptAttribute> : FunctionControllerBase<TFunc, TFuncAttribute, TScriptAttribute> where TFunc : ReportFunction where TFuncAttribute : ReportFunctionAttribute where TScriptAttribute : ReportScriptAttribute
Type Parameters
| Name | Description |
|---|---|
| TFunc | The function |
| TFuncAttribute | The function attribute |
| TScriptAttribute | The script attribute |
Constructors
View SourceReportFunctionController(PayrollHttpClient)
Initializes a new instance of the ReportFunctionController<TFunc, TFuncAttribute, TScriptAttribute> class
Declaration
protected ReportFunctionController(PayrollHttpClient httpClient)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The Report http client |
Properties
View SourceRegulation
The regulation
Declaration
protected IRegulation Regulation { get; }
Property Value
| Type | Description |
|---|---|
| IRegulation |
Tenant
The tenant
Declaration
protected ITenant Tenant { get; }
Property Value
| Type | Description |
|---|---|
| ITenant |
User
The user
Declaration
protected IUser User { get; }
Property Value
| Type | Description |
|---|---|
| IUser |
Methods
View SourceBuildReportRequest(string)
Build the report request using the function attributes
Declaration
public ReportRequest BuildReportRequest(string reportName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
Returns
| Type | Description |
|---|---|
| ReportRequest |
GetReport(string)
Get report
Declaration
protected ReportSet GetReport(string reportName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
Returns
| Type | Description |
|---|---|
| ReportSet |
GetReport(string, ReportRequest)
Get report
Declaration
protected ReportSet GetReport(string reportName, ReportRequest reportRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
| ReportRequest | reportRequest | The report request |
Returns
| Type | Description |
|---|---|
| ReportSet |