fix #1 — replace GetObjectLookup with GetLookupField: fix misleading parameter order (objectKey before lookupKey caused ArgumentException when called with two arguments)

Author: Jani Giannoudis

Client.Scripting/Function/PayrollFunction.Action.cs

@@ -87,10 +87,10 @@ public ActionValue GetLookupValue(string lookup, ActionValue keyOrRangeValue, st
                 lookupKey: keyOrRangeValue));
         }
         // object field lookup value
-        return new(GetObjectLookup<object>(
+        return new(GetLookupField<object>(
             lookupName: lookup,
             lookupKey: keyOrRangeValue,
-            objectKey: field));
+            fieldName: field));
     }
 
     /// <summary>Get lookup value by key and range value</summary>

Client.Scripting/Function/PayrollFunction.cs

@@ -991,7 +991,7 @@ public bool HasLookup(string lookupName) =>
     /// <returns>The typed lookup value, or <c>default(T)</c> when the key is not found</returns>
     /// <remarks>
     /// When the stored value is a JSON object and <typeparamref name="T"/> is not <c>string</c>,
-    /// the JSON is deserialized automatically. Use <see cref="GetObjectLookup{T}(string, string, string, string)"/>
+    /// the JSON is deserialized automatically. Use <see cref="GetLookupField{T}(string, string, string, string)"/>
     /// to extract a single property from a JSON-object lookup value.
     /// </remarks>
     public T GetLookup<T>(string lookupName, string lookupKey, string culture = null)
@@ -1022,16 +1022,16 @@ public T GetLookup<T>(string lookupName, object[] lookupKeyValues, string cultur
         return GetLookup<T>(lookupName, JsonSerializer.Serialize(lookupKeyValues), culture);
     }
 
-    /// <summary>Get object lookup by range value</summary>
+    /// <summary>Get a single field from a JSON-object lookup entry</summary>
     /// <param name="lookupName">The lookup name</param>
-    /// <param name="objectKey">The object key</param>
-    /// <param name="lookupKey">The lookup key (optional)</param>
+    /// <param name="lookupKey">The exact key to look up</param>
+    /// <param name="fieldName">The JSON property name to extract from the object</param>
     /// <param name="culture">The culture, null for the system culture (optional)</param>
-    public T GetObjectLookup<T>(string lookupName, string objectKey,
-        string lookupKey = null, string culture = null)
+    /// <returns>The typed field value, or <c>default(T)</c> when the lookup, key, or field is not found</returns>
+    public T GetLookupField<T>(string lookupName, string lookupKey, string fieldName, string culture = null)
     {
         var value = GetLookup<string>(lookupName, lookupKey, culture);
-        return string.IsNullOrWhiteSpace(value) ? default : value.ObjectValueJson<T>(objectKey);
+        return string.IsNullOrWhiteSpace(value) ? default : value.ObjectValueJson<T>(fieldName);
     }
 
     /// <summary>Get payroll lookup range brackets</summary>

Client.Scripting/PayrollEngine.Client.Scripting.xml

@@ -6352,7 +6352,7 @@
             <returns>The typed lookup value, or <c>default(T)</c> when the key is not found</returns>
             <remarks>
             When the stored value is a JSON object and <typeparamref name="T"/> is not <c>string</c>,
-            the JSON is deserialized automatically. Use <see cref="M:PayrollEngine.Client.Scripting.Function.PayrollFunction.GetObjectLookup``1(System.String,System.String,System.String,System.String)"/>
+            the JSON is deserialized automatically. Use <see cref="M:PayrollEngine.Client.Scripting.Function.PayrollFunction.GetLookupField``1(System.String,System.String,System.String,System.String)"/>
             to extract a single property from a JSON-object lookup value.
             </remarks>
         </member>
@@ -6362,12 +6362,13 @@
             <param name="lookupKeyValues">The lookup key values (serialized to JSON string)</param>
             <param name="culture">The culture, null for the system culture (optional)</param>
         </member>
-        <member name="M:PayrollEngine.Client.Scripting.Function.PayrollFunction.GetObjectLookup``1(System.String,System.String,System.String,System.String)">
-            <summary>Get object lookup by range value</summary>
+        <member name="M:PayrollEngine.Client.Scripting.Function.PayrollFunction.GetLookupField``1(System.String,System.String,System.String,System.String)">
+            <summary>Get a single field from a JSON-object lookup entry</summary>
             <param name="lookupName">The lookup name</param>
-            <param name="objectKey">The object key</param>
-            <param name="lookupKey">The lookup key (optional)</param>
+            <param name="lookupKey">The exact key to look up</param>
+            <param name="fieldName">The JSON property name to extract from the object</param>
             <param name="culture">The culture, null for the system culture (optional)</param>
+            <returns>The typed field value, or <c>default(T)</c> when the lookup, key, or field is not found</returns>
         </member>
         <member name="M:PayrollEngine.Client.Scripting.Function.PayrollFunction.GetLookupRanges(System.String,System.Nullable{System.Decimal})">
             <summary>Get payroll lookup range brackets</summary>