Class ReportStartFunctionInvoker<TFunction>
Report start function invoker
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function.Api
Assembly: PayrollEngine.Client.Services.dll
Syntax
public class ReportStartFunctionInvoker<TFunction> : FunctionInvokerBase where TFunction : ReportStartFunction
Type Parameters
| Name | Description |
|---|---|
| TFunction |
Constructors
View SourceReportStartFunctionInvoker(PayrollHttpClient, ScriptConfiguration, string)
Invoker constructor
Declaration
public ReportStartFunctionInvoker(PayrollHttpClient httpClient, ScriptConfiguration configuration, string queryFileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The Payroll http configuration |
| ScriptConfiguration | configuration | The scripting configuration |
| string | queryFileName | Query output file name |
Properties
View SourceQueryFileName
Query output file name
Declaration
public string QueryFileName { 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 |
Start(ReportSet)
Report start
Declaration
public ReportStartFunctionResult Start(ReportSet report)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportSet | report | The report |
Returns
| Type | Description |
|---|---|
| ReportStartFunctionResult |
Start(ReportSet, ReportRequest)
Report start
Declaration
public ReportStartFunctionResult Start(ReportSet report, ReportRequest reportRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportSet | report | The report |
| ReportRequest | reportRequest | The report request |
Returns
| Type | Description |
|---|---|
| ReportStartFunctionResult |
Start(string)
Report start
Declaration
public ReportStartFunctionResult Start(string reportName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
Returns
| Type | Description |
|---|---|
| ReportStartFunctionResult | The function result |
Start(string, ReportRequest)
Report start
Declaration
public ReportStartFunctionResult Start(string reportName, ReportRequest reportRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| string | reportName | Name of the report |
| ReportRequest | reportRequest | The report request |
Returns
| Type | Description |
|---|---|
| ReportStartFunctionResult | The function result |