added validate messages

Author: SharePointRadi

src/OneBitSoftware.Utilities.OperationResult/OneBitSoftware.Utilities.OperationResult.csproj

@@ -32,7 +32,7 @@
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>OneBitSoftware; OperationResult;</PackageTags>
-    <Version>1.2.1</Version>
+    <Version>1.3.4</Version>
   </PropertyGroup>
 
 </Project>

src/OneBitSoftware.Utilities.OperationResult/OperationResult.cs

@@ -329,5 +329,20 @@ public OperationResult<TResult> AppendErrorMessages<TOther>(TOther otherOperatio
 
             return this;
         }
+
+        /// <summary>
+        /// Sets related object to the provided operation result and returns itself.
+        /// </summary>
+        /// <param name="operationResult">The <see cref="OperationResult{TResult}"/> instance to extend.</param>
+        /// <param name="relatedObject">The value to set to the <see cref="OperationResult{TResult}.ResultObject"/> property.</param>
+        /// <returns>Returns the original <paramref name="operationResult"/> with the appended message.</returns>
+        /// <remarks>
+        /// This method will throw if the provided <paramref name="operationResult"/> is null.
+        /// </remarks>
+        public OperationResult<TResult> WithRelatedObject(TResult relatedObject)
+        {
+            this.ResultObject = relatedObject;
+            return this;
+        }
     }
 }

src/OneBitSoftware.Utilities.OperationResult/OperationResultValidationExtensions.cs

@@ -36,6 +36,34 @@ public static void ValidateAny<T, TValue>(this OperationResult<T> operationResul
             }
         }
 
+        /// <summary>
+        /// Use this method to check if a value is not null and not an empty collection.
+        /// If <paramref name="value"/> is null or an empty collection, an error message should be appended and a log of the passed <paramref name="level"/> severity should be created.
+        /// </summary>
+        /// <typeparam name="TValue">The type of the underlying entities that are stored within the requested collection.</typeparam>
+        /// <param name="operationResult">The <see cref="OperationResult"/> instance.</param>
+        /// <param name="value">The collection that should be validated.</param>
+        /// <param name="className">The name of the class where the <paramref name="methodName"/> is defined.</param>
+        /// <param name="methodName">The name of the method where <paramref name="value"/> is used.</param>
+        /// <param name="identifierPropertyName">The name of the entity's unique identifier property.</param>
+        /// <param name="level">The logging severity.</param>
+        public static void ValidateAny<TValue>(this OperationResult operationResult, IEnumerable<TValue> value, string className, string methodName, string identifierPropertyName, LogLevel level = LogLevel.Error)
+        {
+            // If the passed value is null, log and append an error message.
+            if (value == null)
+            {
+                var errorMessage = $"{className}, {methodName} - An entity with that {identifierPropertyName} does not exist.";
+                operationResult.AppendError(errorMessage, logLevel: level);
+            }
+
+            // If the passed value is an empty collection, log and append an error message.
+            else if (!value.Any())
+            {
+                var errorMessage = $"{className}, {methodName} - The collection with that {identifierPropertyName} is empty which is not permitted.";
+                operationResult.AppendError(errorMessage, logLevel: level);
+            }
+        }
+
         /// <summary>
         /// Use this method to check if a value is equal to its default value.
         /// If <paramref name="value"/> is equal to its default value, an error message should be appended and a log of the passed <paramref name="level"/> severity would be created.
@@ -57,6 +85,26 @@ public static void ValidateDefault<T, TValue>(this OperationResult<T> operationR
             operationResult.AppendError(errorMessage, logLevel: level);
         }
 
+        /// <summary>
+        /// Use this method to check if a value is equal to its default value.
+        /// If <paramref name="value"/> is equal to its default value, an error message should be appended and a log of the passed <paramref name="level"/> severity would be created.
+        /// </summary>
+        /// <typeparam name="TValue">The type of the <paramref name="value"/>.</typeparam>
+        /// <param name="value">The value that should be validated.</param>
+        /// <param name="className">The name of the class where the <paramref name="methodName"/> is defined.</param>
+        /// <param name="methodName">The name of he method where <paramref name="value"/> is used.</param>
+        /// <param name="propertyName">The name of the property.</param>
+        /// <param name="level">The logging severity.</param>
+        public static void ValidateDefault<TValue>(this OperationResult operationResult, TValue value, string className, string methodName, string propertyName, LogLevel level = LogLevel.Error)
+            where TValue : struct, IEquatable<TValue>
+        {
+            // If the passed value is null, log and append an error message.
+            if (value.Equals(default) == false) return;
+
+            var errorMessage = $"{className}, {methodName} - The {propertyName} has a default value.";
+            operationResult.AppendError(errorMessage, logLevel: level);
+        }
+
         /// <summary>
         /// Use this method to check if a value is a valid string.
         /// If <paramref name="value"/> is null, empty or consists only of whitespace characters, an error message should be appended and a log of the passed <paramref name="level"/> severity would be created.
@@ -76,6 +124,24 @@ public static void ValidateNullOrWhitespace<T>(this OperationResult<T> operation
             operationResult.AppendError(errorMessage, logLevel: level);
         }
 
+        /// <summary>
+        /// Use this method to check if a value is a valid string.
+        /// If <paramref name="value"/> is null, empty or consists only of whitespace characters, an error message should be appended and a log of the passed <paramref name="level"/> severity would be created.
+        /// </summary>
+        /// <param name="value">The value that should be validated.</param>
+        /// <param name="className">The name of the class where the <paramref name="methodName"/> is defined.</param>
+        /// <param name="methodName">The name of he method where <paramref name="value"/> is used.</param>
+        /// <param name="propertyName">The name of the property.</param>
+        /// <param name="level">The logging severity.</param>
+        public static void ValidateNullOrWhitespace(this OperationResult operationResult, string value, string className, string methodName, string propertyName, LogLevel level = LogLevel.Error)
+        {
+            // If the passed value is null, empty or consists only of whitespace characters, log and append an error message.
+            if (string.IsNullOrWhiteSpace(value) == false) return;
+
+            var errorMessage = $"{className}, {methodName} - The {propertyName} is null, empty or consists only of whitespace characters.";
+            operationResult.AppendError(errorMessage, logLevel: level);
+        }
+
         /// <summary>
         /// Use this method to check if a value is not null.
         /// If you want to validate that an entity exists, use the "ValidateExist" extension method.