< Summary

Information
Class: Elsa.Workflows.Management.IWorkflowDefinitionFilterProvider
Assembly: Elsa.Workflows.Management
File(s): /home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Management/Contracts/IWorkflowDefinitionFilterProvider.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 1
Coverable lines: 1
Total lines: 30
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
GetRequiredPermissions(...)100%210%

File(s)

/home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Management/Contracts/IWorkflowDefinitionFilterProvider.cs

#LineLine coverage
 1using Elsa.Authorization;
 2using Elsa.Workflows.Management.Filters;
 3
 4namespace Elsa.Workflows.Management;
 5
 6/// <summary>
 7/// Applies an optional workflow definition filter that is provided by another module. A provider should leave an omitte
 8/// </summary>
 9public interface IWorkflowDefinitionFilterProvider
 10{
 11    /// <summary>
 12    /// Gets a value indicating whether this provider can apply criteria to the specified filter.
 13    /// </summary>
 14    /// <param name="filter">The filter to inspect.</param>
 15    bool CanApply(WorkflowDefinitionFilter filter);
 16
 17    /// <summary>
 18    /// Gets the permissions required before this provider can inspect data for the specified filter.
 19    /// </summary>
 20    /// <param name="filter">The filter to inspect.</param>
 021    IEnumerable<Permission> GetRequiredPermissions(WorkflowDefinitionFilter filter) => [];
 22
 23    /// <summary>
 24    /// Applies the provider's criteria to the specified filter.
 25    /// </summary>
 26    /// <remarks>Criteria that remain non-empty after all providers have run are reported as unsupported by the API.</re
 27    /// <param name="filter">The filter to update.</param>
 28    /// <param name="cancellationToken">The cancellation token.</param>
 29    Task ApplyAsync(WorkflowDefinitionFilter filter, CancellationToken cancellationToken = default);
 30}