Class ReportEndFunctionInvoker<TFunction>
Report end function invoker
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function.Api
Assembly: PayrollEngine.Client.Services.dll
Syntax
public class ReportEndFunctionInvoker<TFunction> : FunctionInvokerBase where TFunction : ReportEndFunction
Type Parameters
| Name | Description |
|---|---|
| TFunction |
Constructors
View SourceReportEndFunctionInvoker(PayrollHttpClient, ScriptConfiguration, string, string)
Invoker constructor
Declaration
public ReportEndFunctionInvoker(PayrollHttpClient httpClient, ScriptConfiguration configuration, string queryFileName = null, string resultFileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The Payroll http configuration |
| ScriptConfiguration | configuration | The scripting configuration |
| string | queryFileName | Query input file name |
| string | resultFileName | Result output file name |
Properties
View SourceQueryFileName
Query input file name
Declaration
public string QueryFileName { get; }
Property Value
| Type | Description |
|---|---|
| string |
ResultFileName
Result output file name
Declaration
public string ResultFileName { get; }
Property Value
| Type | Description |
|---|---|
| string |
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 |
End(ReportSet, ReportRequest, DataSet)
Report end
Declaration
public ReportEndFunctionResult End(ReportSet report, ReportRequest reportRequest, DataSet dataSet = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportSet | report | The report |
| ReportRequest | reportRequest | The report request |
| DataSet | dataSet | The report data set |
Returns
| Type | Description |
|---|---|
| ReportEndFunctionResult | The function result |
End(ReportSet, DataSet)
Report end
Declaration
public ReportEndFunctionResult End(ReportSet report, DataSet dataSet = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportSet | report | The report |
| DataSet | dataSet | The report data set |
Returns
| Type | Description |
|---|---|
| ReportEndFunctionResult | The function result |
End(string, ReportRequest, DataSet)
Report end
Declaration
public ReportEndFunctionResult End(string reportName, ReportRequest reportRequest, DataSet dataSet = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
| ReportRequest | reportRequest | The report request |
| DataSet | dataSet | The report data set |
Returns
| Type | Description |
|---|---|
| ReportEndFunctionResult | The function result |
End(string, DataSet)
Report end
Declaration
public ReportEndFunctionResult End(string reportName, DataSet dataSet = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
| DataSet | dataSet | The report data set |
Returns
| Type | Description |
|---|---|
| ReportEndFunctionResult | The function result |