Table of Contents

Class IssueFilter

Namespace
Quilt4Net.Toolkit.Features.Issue
Assembly
Quilt4Net.Toolkit.dll

Which issues a view shows. One model, read by the board, the list and the roadmap alike, so the three cannot disagree about what is being looked at.

public record IssueFilter : IEquatable<IssueFilter>
Inheritance
IssueFilter
Implements
Inherited Members

Remarks

An empty selection means everything in that dimension, not nothing. An untouched filter then reads as no choice rather than as a choice of every value, and "no opinion" stays expressible.

Fields

None

A filter that lets every issue through.

public static readonly IssueFilter None

Field Value

IssueFilter

Properties

Bands

Bands to show, or empty for all.

public IReadOnlyCollection<RoadmapBand> Bands { get; init; }

Property Value

IReadOnlyCollection<RoadmapBand>

Efforts

Efforts to show, or empty for all. An issue with no effort is excluded as soon as any is selected.

public IReadOnlyCollection<IssueEffort> Efforts { get; init; }

Property Value

IReadOnlyCollection<IssueEffort>

Importances

Importances to show, or empty for all. An issue with no importance is excluded as soon as any importance is selected, because it has not been triaged into any of them.

public IReadOnlyCollection<IssueImportance> Importances { get; init; }

Property Value

IReadOnlyCollection<IssueImportance>

IsEmpty

Whether no dimension narrows anything.

public bool IsEmpty { get; }

Property Value

bool

Limit

At most this many of the issues with a place in the team's order, the first in it, or null (or anything below one) for no limit. An issue with no place, such as a finished one, is left to the other dimensions. It is about the set rather than one issue, so Matches(RoadmapBand?, IssueImportance?, IssueEffort?, string) does not judge it: the view that ranks applies it, and a view that does not rank leaves it unset.

public int? Limit { get; init; }

Property Value

int?

Readiness

Which conditions of open work to show (#131): blocked, waiting, ready; empty, or all three, for everything. An issue both blocked and waiting is shown for either. Narrowed to some, the finished issues are left out, since they are not work to pick up. The caller says what an issue is, through IncludesReadiness(bool, bool, bool).

public IReadOnlyCollection<IssueReadiness> Readiness { get; init; }

Property Value

IReadOnlyCollection<IssueReadiness>

States

Workflow states to show, by their team-defined name, or empty for all. Names rather than a fixed set, because the states belong to the team's workflow.

public IReadOnlyCollection<string> States { get; init; }

Property Value

IReadOnlyCollection<string>

Methods

IncludesBand(RoadmapBand)

Whether a band is shown. Separate from Matches(RoadmapBand?, IssueImportance?, IssueEffort?, string) so a view can drop a whole band rather than draw it empty.

public bool IncludesBand(RoadmapBand band)

Parameters

band RoadmapBand

Returns

bool

IncludesReadiness(bool, bool, bool)

Whether an issue in this condition is shown.

public bool IncludesReadiness(bool open, bool blocked, bool waiting)

Parameters

open bool

The issue is not in a terminal state.

blocked bool

An open issue blocks it.

waiting bool

It carries a waiting flag.

Returns

bool

IncludesState(string)

Whether a workflow state is shown.

public bool IncludesState(string state)

Parameters

state string

Returns

bool

Matches(RoadmapBand?, IssueImportance?, IssueEffort?, string)

Whether an issue with these values is shown. A null band means the source could not say, which a band filter cannot judge, so it passes.

public bool Matches(RoadmapBand? band, IssueImportance? importance, IssueEffort? effort, string state)

Parameters

band RoadmapBand?
importance IssueImportance?
effort IssueEffort?
state string

Returns

bool

Matches(RoadmapBand?, IssueImportance?, IssueEffort?, string, bool, bool, bool)

public bool Matches(RoadmapBand? band, IssueImportance? importance, IssueEffort? effort, string state, bool open, bool blocked, bool waiting)

Parameters

band RoadmapBand?
importance IssueImportance?
effort IssueEffort?
state string
open bool
blocked bool
waiting bool

Returns

bool

OpenStates(IssueWorkflowResponse)

The default view of a workflow: every state that is not terminal. Finished work is opt-in, because it outnumbers open work on any tracker that has been used for a while.

public static IssueFilter OpenStates(IssueWorkflowResponse workflow)

Parameters

workflow IssueWorkflowResponse

Returns

IssueFilter