added abort execution to the wage type value function and runtime

Author: Jani Giannoudis

Client.Scripting/Function/WageTypeValueFunction.cs

@@ -1,4 +1,4 @@
-/* WageTypeValueFunction */
+/* WageTypeValueFunction */
 
 // ReSharper disable RedundantUsingDirective
 using System;
@@ -95,6 +95,15 @@ protected WageTypeValueFunction(string sourceFileName) :
     /// <summary>Restart execution of wage type calculation</summary>
     public void RestartExecution() => Runtime.RestartExecution();
 
+    /// <summary>
+    /// Aborts the wage type sequence for the current employee immediately.
+    /// All subsequent wage types are skipped for this employee in this payrun.
+    /// CollectorEnd and PayrunEmployeeEnd continue normally.
+    /// </summary>
+    /// <param name="reason">Optional reason written to the payrun log.</param>
+    public void AbortExecution(string reason = null) =>
+        Runtime.AbortExecution(reason);
+
     #region Action
     #endregion
 
@@ -111,4 +120,4 @@ public object GetValue()
         // compiler will optimize this out if the code provides a return
         return null;
     }
-}
+}

Client.Scripting/PayrollEngine.Client.Scripting.xml

@@ -8429,6 +8429,14 @@
         <member name="M:PayrollEngine.Client.Scripting.Function.WageTypeValueFunction.RestartExecution">
             <summary>Restart execution of wage type calculation</summary>
         </member>
+        <member name="M:PayrollEngine.Client.Scripting.Function.WageTypeValueFunction.AbortExecution(System.String)">
+            <summary>
+            Aborts the wage type sequence for the current employee immediately.
+            All subsequent wage types are skipped for this employee in this payrun.
+            CollectorEnd and PayrunEmployeeEnd continue normally.
+            </summary>
+            <param name="reason">Optional reason written to the payrun log.</param>
+        </member>
         <member name="M:PayrollEngine.Client.Scripting.Function.WageTypeValueFunction.GetValue">
             <summary>Entry point for the runtime</summary>
             <remarks>Internal usage only, do not call this method</remarks>
@@ -11501,6 +11509,14 @@
         <member name="M:PayrollEngine.Client.Scripting.Runtime.IWageTypeValueRuntime.RestartExecution">
             <summary>Restart execution of wage type calculation</summary>
         </member>
+        <member name="M:PayrollEngine.Client.Scripting.Runtime.IWageTypeValueRuntime.AbortExecution(System.String)">
+            <summary>
+            Aborts the wage type sequence for the current employee immediately.
+            All subsequent wage types are skipped. CollectorEnd and PayrunEmployeeEnd
+            continue normally.
+            </summary>
+            <param name="reason">Optional reason written to the payrun log.</param>
+        </member>
         <member name="M:PayrollEngine.Client.Scripting.Runtime.IWageTypeValueRuntime.GetValueActions">
             <summary>Get wage type value actions</summary>
         </member>

Client.Scripting/Runtime/IWageTypeValueRuntime.cs

@@ -1,4 +1,4 @@
-
+
 namespace PayrollEngine.Client.Scripting.Runtime;
 
 /// <summary>Runtime for the wage type value function <see cref="Function.WageTypeValueFunction"/></summary>
@@ -10,6 +10,14 @@ public interface IWageTypeValueRuntime : IWageTypeRuntime
     /// <summary>Restart execution of wage type calculation</summary>
     void RestartExecution();
 
+    /// <summary>
+    /// Aborts the wage type sequence for the current employee immediately.
+    /// All subsequent wage types are skipped. CollectorEnd and PayrunEmployeeEnd
+    /// continue normally.
+    /// </summary>
+    /// <param name="reason">Optional reason written to the payrun log.</param>
+    void AbortExecution(string reason = null);
+
     /// <summary>Get wage type value actions</summary>
     string[] GetValueActions();
-}
+}