Class CaseAvailableController<TFunc>
Case available function controller
Inheritance
CaseAvailableController<TFunc>
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function.Api
Assembly: PayrollEngine.Client.Services.dll
Syntax
public class CaseAvailableController<TFunc> : CaseController<TFunc, CaseAvailableFunctionAttribute, CaseAvailableScriptAttribute> where TFunc : CaseAvailableFunctionType Parameters
| Name | Description |
|---|---|
| TFunc |
Constructors
View SourceCaseAvailableController(PayrollHttpClient, ScriptConfiguration)
Initializes a new instance of the CaseAvailableController<TFunc> class
Declaration
public CaseAvailableController(PayrollHttpClient httpClient, ScriptConfiguration configuration)Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The Payroll http client |
| ScriptConfiguration | configuration | The scripting configuration |
Methods
View SourceIsAvailable(string)
Determines whether the existing case is available
Declaration
public CaseAvailableFunctionResult IsAvailable(string caseName)Parameters
| Type | Name | Description |
|---|---|---|
| string | caseName | Name of the case |
Returns
| Type | Description |
|---|---|
| CaseAvailableFunctionResult | True if the specified case is available |
IsAvailable(string, Case)
Determines whether the specified case is available
Declaration
public CaseAvailableFunctionResult IsAvailable(string caseName, Case @case)Parameters
| Type | Name | Description |
|---|---|---|
| string | caseName | Name of the case |
| Case | case | The case to validate |
Returns
| Type | Description |
|---|---|
| CaseAvailableFunctionResult | True if the specified case is available |