Refactor CMFRTAQFSResolveItemToGLAcc to pass IsHandled to DoCMFRTAQFSResolveItemToGLAcc and update documentation for clarity on event handling structure

This commit is contained in:
BeytullahCengiz88 2026-07-16 12:03:23 +02:00
parent a63a3614a9
commit 4f74b884d8
2 changed files with 7 additions and 9 deletions

View file

@ -6,20 +6,18 @@ codeunit 55043 "CMFRT AQ FS ProForma Meth"
begin begin
IsHandled := false; IsHandled := false;
OnBeforeCMFRTAQFSResolveItemToGLAcc(SalesLine, IsHandled); OnBeforeCMFRTAQFSResolveItemToGLAcc(SalesLine, IsHandled);
if IsHandled then DoCMFRTAQFSResolveItemToGLAcc(SalesLine, IsHandled);
exit;
DoCMFRTAQFSResolveItemToGLAcc(SalesLine);
OnAfterCMFRTAQFSResolveItemToGLAcc(SalesLine); OnAfterCMFRTAQFSResolveItemToGLAcc(SalesLine);
end; end;
local procedure DoCMFRTAQFSResolveItemToGLAcc(var SalesLine: Record "Sales Line") local procedure DoCMFRTAQFSResolveItemToGLAcc(var SalesLine: Record "Sales Line"; IsHandled: Boolean)
var var
Item: Record Item; Item: Record Item;
GeneralPostingSetup: Record "General Posting Setup"; GeneralPostingSetup: Record "General Posting Setup";
ItemNotFoundErr: Label 'Item %1 was not found.', Comment = '%1 = Item No.'; ItemNotFoundErr: Label 'Item %1 was not found.', Comment = '%1 = Item No.';
begin begin
if IsHandled then
exit;
Item.SetLoadFields("No.", "Gen. Prod. Posting Group", Description); Item.SetLoadFields("No.", "Gen. Prod. Posting Group", Description);
if not Item.Get(SalesLine."CMFRT AQ FS Item No.") then if not Item.Get(SalesLine."CMFRT AQ FS Item No.") then
Error(ItemNotFoundErr, SalesLine."CMFRT AQ FS Item No."); Error(ItemNotFoundErr, SalesLine."CMFRT AQ FS Item No.");

View file

@ -11,16 +11,16 @@ application-area: [all]
## Description ## Description
Global procedures in CMFRT Meth codeunits are thin shells: the body consists of firing `OnBefore<Name>` with `var IsHandled: Boolean`, exiting if handled, calling a local `Do<Name>` procedure that holds all business logic, and firing `OnAfter<Name>`. Local variables that only serve the business logic (record buffers, labels, working values) live in the `Do` procedure, not in the shell. This keeps the event bracket structurally impossible to bypass — the `OnAfter` event cannot be skipped by an early `exit` inside business logic, because business logic lives one level down. Global procedures in CMFRT Meth codeunits are thin shells: the body consists of firing `OnBefore<Name>` with `var IsHandled: Boolean`, calling a local `Do<Name>` procedure that holds all business logic and the `if IsHandled then exit;` guard, and firing `OnAfter<Name>`. Local variables that only serve the business logic (record buffers, labels, working values) live in the `Do` procedure, not in the shell. This keeps the event bracket structurally impossible to bypass — the `OnAfter` event cannot be skipped by an early `exit` inside business logic, because business logic and handled exits live one level down.
## Best Practice ## Best Practice
Write every global Meth procedure as: reset `IsHandled`, fire `OnBefore`, `if IsHandled then exit;`, call `Do<Name>(...)`, fire `OnAfter`. When review finds a global procedure whose body mixes event calls with business logic, extract the logic into `Do<Name>` and move its private variables and labels along with it. Write every global Meth procedure as: reset `IsHandled`, fire `OnBefore`, call `Do<Name>(..., IsHandled)`, fire `OnAfter`. In `Do<Name>`, place `if IsHandled then exit;` as the first executable statement, then execute business logic. When review finds a global procedure whose body mixes event calls with business logic, extract the logic into `Do<Name>` and move its private variables and labels along with it.
See sample: `cmfrt-onbefore-do-onafter.good.al`. See sample: `cmfrt-onbefore-do-onafter.good.al`.
## Anti Pattern ## Anti Pattern
A global procedure whose business logic sits inline between the `OnBefore` and `OnAfter` calls. Inline bodies grow early `exit` paths that silently skip the `OnAfter` event, and their local variables and labels accumulate at the shell level where every branch can touch them. Equally wrong: declaring the event pair but never calling the events from the procedure (dead events), which advertises an extension point that never fires. A global procedure that keeps `if IsHandled then exit;` and business logic inline between the `OnBefore` and `OnAfter` calls. Inline bodies grow early `exit` paths that silently skip the `OnAfter` event, and their local variables and labels accumulate at the shell level where every branch can touch them. Equally wrong: declaring the event pair but never calling the events from the procedure (dead events), which advertises an extension point that never fires.
See sample: `cmfrt-onbefore-do-onafter.bad.al`. See sample: `cmfrt-onbefore-do-onafter.bad.al`.