Interface ITenantService

Payroll tenant service

Inherited Members
Namespace: PayrollEngine.Client.Service
Assembly: PayrollEngine.Client.Core.dll
Syntax
public interface ITenantService : ICrudService<ITenant, RootServiceContext, Query>, ICreateService<ITenant, RootServiceContext, Query>, IReadService<ITenant, RootServiceContext, Query>, IAttributeService<RootServiceContext>

Methods

ExecuteReportQueryAsync(int, string, string, Dictionary<string, string>)

Execute a report query

Declaration
Task<DataTable> ExecuteReportQueryAsync(int tenantId, string methodName, string culture, Dictionary<string, string> parameters = null)
Parameters
Type Name Description
int tenantId

The tenant id
string methodName

The query method
string culture

The culture name based on RFC 4646
Dictionary<string, string> parameters

The query parameters
Returns
Type Description
Task<DataTable>

The resulting data table

GetAsync<T>(RootServiceContext, string)

Get tenant by identifier

Declaration
Task<T> GetAsync<T>(RootServiceContext context, string identifier) where T : class, ITenant
Parameters
Type Name Description
RootServiceContext context

The service context
string identifier

The tenant identifier
Returns
Type Description
Task<T>

The tenant, null if missing
Type Parameters
Name Description
T

GetSharedRegulationsAsync<T>(int, int?)

Get tenant shared regulations

Declaration
Task<List<T>> GetSharedRegulationsAsync<T>(int tenantId, int? divisionId) where T : class, IRegulation
Parameters
Type Name Description
int tenantId

The tenant id
int? divisionId

The division id
Returns
Type Description
Task<List<T>>

The tenant shared regulations
Type Parameters
Name Description
T

GetSystemScriptActionPropertiesAsync<TAction>(int, FunctionType, bool)

Get the system script action properties

Declaration
Task<List<TAction>> GetSystemScriptActionPropertiesAsync<TAction>(int tenantId, FunctionType functionType = FunctionType.All, bool readOnly = true) where TAction : ActionInfo
Parameters
Type Name Description
int tenantId

The tenant id
FunctionType functionType

The function type
bool readOnly

Read-only properties only (default: true)
Returns
Type Description
Task<List<TAction>>

The system action script properties
Type Parameters
Name Description
TAction

GetSystemScriptActionsAsync<TAction>(int, FunctionType)

Get the system script actions

Declaration
Task<List<TAction>> GetSystemScriptActionsAsync<TAction>(int tenantId, FunctionType functionType = FunctionType.All) where TAction : ActionInfo
Parameters
Type Name Description
int tenantId

The tenant id
FunctionType functionType

The function type
Returns
Type Description
Task<List<TAction>>

The system action scripts
Type Parameters
Name Description
TAction

Extension Methods