Feat/471 Re-add Success property to UserActionResult (#613)

* Re-add Success property to UserActionResult. * Remove empty param comments. * dotnet format
Altinn · Apr 24, 2024 · dd0de6c · dd0de6c
1 parent f40c89e
commit dd0de6c
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 42 deletions.
diff --git a/src/Altinn.App.Core/Internal/Process/EventHandlers/EndEventEventHandler.cs b/src/Altinn.App.Core/Internal/Process/EventHandlers/EndEventEventHandler.cs
@@ -27,10 +27,6 @@ public EndEventEventHandler(IAppEvents appEvents, IInstanceClient instanceClient
         /// <summary>
         /// Execute the event handler logic.
         /// </summary>
-        /// <param name="instanceEvent"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
-        /// <exception cref="ArgumentException"></exception>
         public async Task Execute(InstanceEvent instanceEvent, Instance instance)
         {
             string? endEvent = instanceEvent.ProcessInfo?.EndEvent;

diff --git a/src/Altinn.App.Core/Internal/Process/EventHandlers/Interfaces/IEndEventEventHandler.cs b/src/Altinn.App.Core/Internal/Process/EventHandlers/Interfaces/IEndEventEventHandler.cs
@@ -10,9 +10,6 @@ public interface IEndEventEventHandler
         /// <summary>
         /// Execute the end event handler
         /// </summary>
-        /// <param name="instanceEvent"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
         Task Execute(InstanceEvent instanceEvent, Instance instance);
     }
 }
diff --git a/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/AbandonTaskEventHandler.cs b/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/AbandonTaskEventHandler.cs
@@ -14,7 +14,6 @@ public class AbandonTaskEventHandler : IAbandonTaskEventHandler
         /// <summary>
         /// This event handler is responsible for handling the abandon event for a process task.
         /// </summary>
-        /// <param name="processTaskAbondons"></param>
         public AbandonTaskEventHandler(IEnumerable<IProcessTaskAbandon> processTaskAbondons)
         {
             _processTaskAbondons = processTaskAbondons;
@@ -23,10 +22,6 @@ public AbandonTaskEventHandler(IEnumerable<IProcessTaskAbandon> processTaskAbond
         /// <summary>
         /// Handles the abandon event for a process task.
         /// </summary>
-        /// <param name="processTask"></param>
-        /// <param name="taskId"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
         public async Task Execute(IProcessTask processTask, string taskId, Instance instance)
         {
             await processTask.Abandon(taskId, instance);
@@ -36,9 +31,6 @@ public async Task Execute(IProcessTask processTask, string taskId, Instance inst
         /// <summary>
         /// Runs IProcessTaskAbandons defined in the app.
         /// </summary>
-        /// <param name="taskId"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
         private async Task RunAppDefinedProcessTaskAbandonHandlers(string taskId, Instance instance)
         {
             foreach (IProcessTaskAbandon taskAbandon in _processTaskAbondons)

diff --git a/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/EndTaskEventHandler.cs b/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/EndTaskEventHandler.cs
@@ -42,10 +42,6 @@ ILogger<EndTaskEventHandler> logger
         /// <summary>
         /// Execute the event handler logic.
         /// </summary>
-        /// <param name="processTask"></param>
-        /// <param name="taskId"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
         public async Task Execute(IProcessTask processTask, string taskId, Instance instance)
         {
             await processTask.End(taskId, instance);
@@ -71,9 +67,6 @@ public async Task Execute(IProcessTask processTask, string taskId, Instance inst
         /// <summary>
         /// Runs IProcessTaskEnds defined in the app.
         /// </summary>
-        /// <param name="endEvent"></param>
-        /// <param name="instance"></param>
-        /// <returns></returns>
         private async Task RunAppDefinedProcessTaskEndHandlers(string endEvent, Instance instance)
         {
             foreach (IProcessTaskEnd taskEnd in _processTaskEnds)

diff --git a/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/StartTaskEventHandler.cs b/src/Altinn.App.Core/Internal/Process/EventHandlers/ProcessTask/StartTaskEventHandler.cs
@@ -30,11 +30,6 @@ IEnumerable<IProcessTaskStart> processTaskStarts
         /// <summary>
         /// Execute the event handler logic.
         /// </summary>
-        /// <param name="processTask"></param>
-        /// <param name="taskId"></param>
-        /// <param name="instance"></param>
-        /// <param name="prefill"></param>
-        /// <returns></returns>
         public async Task Execute(IProcessTask processTask, string taskId, Instance instance,
             Dictionary<string, string>? prefill)
         {
@@ -47,10 +42,6 @@ public async Task Execute(IProcessTask processTask, string taskId, Instance inst
         /// <summary>
         /// Runs IProcessTaskStarts defined in the app.
         /// </summary>
-        /// <param name="taskId"></param>
-        /// <param name="instance"></param>
-        /// <param name="prefill"></param>
-        /// <returns></returns>
         private async Task RunAppDefinedProcessTaskStartHandlers(string taskId, Instance instance,
             Dictionary<string, string>? prefill)
         {

diff --git a/src/Altinn.App.Core/Internal/Process/ProcessEventHandlingDelegator.cs b/src/Altinn.App.Core/Internal/Process/ProcessEventHandlingDelegator.cs
@@ -40,10 +40,6 @@ public ProcessEventHandlingDelegator(ILogger<ProcessEventHandlingDelegator> logg
         /// <summary>
         /// Loops through all events and delegates the event to the correct event handler.
         /// </summary>
-        /// <param name="instance"></param>
-        /// <param name="events"></param>
-        /// <param name="prefill"></param>
-        /// <returns></returns>
         public async Task HandleEvents(Instance instance, Dictionary<string, string>? prefill, List<InstanceEvent>? events)
         {
             if (events == null)
@@ -94,7 +90,6 @@ await _startTaskEventHandler.Execute(GetProcessTaskInstance(altinnTaskType), tas
         /// <summary>
         /// Identify the correct task implementation
         /// </summary>
-        /// <returns></returns>
         private IProcessTask GetProcessTaskInstance(string? altinnTaskType)
         {
             if (string.IsNullOrEmpty(altinnTaskType))

diff --git a/src/Altinn.App.Core/Internal/Process/ServiceTasks/Interfaces/IServiceTask.cs b/src/Altinn.App.Core/Internal/Process/ServiceTasks/Interfaces/IServiceTask.cs
@@ -10,8 +10,5 @@ public interface IServiceTask
     /// <summary>
     /// Executes the service task.
     /// </summary>
-    /// <param name="taskId"></param>
-    /// <param name="instance"></param>
-    /// <returns></returns>
     public Task Execute(string taskId, Instance instance);
 }
diff --git a/src/Altinn.App.Core/Models/UserAction/UserActionResult.cs b/src/Altinn.App.Core/Models/UserAction/UserActionResult.cs
@@ -28,7 +28,12 @@ public class UserActionResult
     /// <summary>
     /// Gets or sets a value indicating whether the user action was a success
     /// </summary>
-    public ResultType ResultType { get; init; }
+    public bool Success { get; init; }
+
+    /// <summary>
+    /// Indicates the type of result
+    /// </summary>
+    public ResultType ResultType { get; set; }
 
     /// <summary>
     /// Gets or sets a dictionary of updated data models. Key should be elementId and value should be the updated data model
@@ -61,12 +66,12 @@ public class UserActionResult
     /// <returns></returns>
     public static UserActionResult SuccessResult(List<ClientAction>? clientActions = null)
     {
-        var userActionResult = new UserActionResult
+        return new UserActionResult
         {
+            Success = true,
             ResultType = ResultType.Success,
             ClientActions = clientActions
         };
-        return userActionResult;
     }
 
     /// <summary>
@@ -93,6 +98,7 @@ public static UserActionResult RedirectResult(string redirectUrl)
     {
         return new UserActionResult
         {
+            Success = true,
             ResultType = ResultType.Redirect,
             RedirectUrl = redirectUrl
         };