Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class TenantGlobalParameterApi

OptimaJet.Workflow.Core.Persistence.TenantGlobalParameterApi

Provides tenant-bound global parameter operations.

Namespace: OptimaJet.Workflow.Core.Persistence

public sealed class TenantGlobalParameterApi

Inheritance

  • System.Object

Constructors

public TenantGlobalParameterApi(IPersistenceProvider persistenceProvider, string? tenantId) #
Creates a tenant-bound global parameter API.

Parameters

Name
Type
Description
persistenceProvider
IPersistenceProvider
Persistence provider.
tenantId
String
Tenant identifier. If null or whitespace, shared global parameters are used.

Properties

Name
Type
TenantId #
String
Tenant identifier used by this API.

Methods

public Task SaveAsync<T>(string type, string name, T value) #
Saves a global parameter in this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameter.
name
String
Parameter name.
value
{T}
Parameter value.

Returns

Type
Description
Task
public Task<T> LoadAsync<T>(string type, string name) #
Loads a global parameter from this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameter.
name
String
Parameter name.

Returns

Type
Description
Task<T>
Parameter value.
public Task<Dictionary<string, T>> LoadWithNamesAsync<T>(string type, Sorting? sort = null) #
Loads named global parameters from this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameters.
sort
Sorting
Field for sorting parameters.

Returns

Type
Description
Task<String,{T>
Dictionary of parameter names and values.
public Task<List<T>> LoadValuesAsync<T>(string type, Sorting? sort = null) #
Loads global parameter values from this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameters.
sort
Sorting
Field for sorting parameters.

Returns

Type
Description
Task<List<T>>
List of parameter values.
public Task<PagedResponse<T>> LoadWithPagingAsync<T>(string type, Paging paging, Sorting? sort = null) #
Loads global parameter values with paging from this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameters.
paging
Paging
Paging settings.
sort
Sorting
Field for sorting parameters.

Returns

Type
Description
Task<PagedResponse<T>>
Global parameter values with paging and total quantity.
public Task DeleteAsync(string type, string? name = null) #
Deletes global parameters from this tenant scope.

Parameters

Name
Type
Description
type
String
Logical type of the parameters.
name
String
Optional parameter name.

Returns

Type
Description
Task