Assembly: OptimaJet.Workflow.Core

Class ProcessInstanceTenantGlobalParameterExtensions

OptimaJet.Workflow.Core.Model.ProcessInstanceTenantGlobalParameterExtensions

Provides an extension method for creating a TenantGlobalParameterApi whose operations are scoped by ProcessInstance.TenantId.

Namespace: OptimaJet.Workflow.Core.Model

public static class ProcessInstanceTenantGlobalParameterExtensions

Methods

public static TenantGlobalParameterApi GetTenantGlobalParameterApi(this ProcessInstance processInstance) #
Creates a TenantGlobalParameterApi scoped to the tenant identified by ProcessInstance.TenantId on processInstance.

Parameters

Name
Type
Description
processInstance
ProcessInstance
The ProcessInstance whose ProcessInstance.TenantId defines the global parameter scope.

Returns

Type
Description
TenantGlobalParameterApi
A new TenantGlobalParameterApi for the tenant scope identified by ProcessInstance.TenantId on processInstance.

Exceptions

Type
Description
ArgumentNullException
processInstance is null.

Remarks

If the ProcessInstance.TenantId of processInstance is null, empty, or contains only white-space characters, the returned TenantGlobalParameterApi uses the shared global parameter scope.