bcquality/microsoft/knowledge/style/binary-choice-must-be-boolean.md
Michael Dieringer 057e17c202 Add 18 community AL/BC patterns across style, data-modeling, web-services, appsource, breaking-changes, performance, and testing
Contributed by CURABIS ApS, generalized from patterns observed across real AppSource/PTE development. Each article follows the knowledge file format (frontmatter, Description/Best Practice/Anti Pattern, sibling .good.al/.bad.al samples).
2026-09-21 22:24:07 +02:00

1.3 KiB

bc-version domain keywords technologies countries application-area
all
style
boolean
option
yes-no
magic-number
variable-typing
field-typing
al
w1
all

Binary yes/no choices must be typed as Boolean, not Option or Integer

Contributions welcome — open a PR to refine or extend this article.

Description

When a field or variable represents exactly two states — yes/no, on/off, active/inactive, blocked/not blocked — it should be typed Boolean. Modeling that same two-state choice as an Option/Enum with two members, or as an Integer with two magic-number values, adds a layer of indirection a reader has to resolve before understanding the code, and it invites a multi-branch check where a simple if X then would do. This is distinct from a genuine multi-value choice with more than two named states, which legitimately calls for Enum — the line is the state count.

Best Practice

Type a true two-state field or variable as Boolean and branch on it directly.

See sample: binary-choice-must-be-boolean.good.al.

Anti Pattern

Modeling a yes/no choice as an Option with two members, or as an Integer with magic-number values, forces every caller to remember which value means what and leaves room for a meaningless third value.

See sample: binary-choice-must-be-boolean.bad.al.