Merge pull request #67 from Worth-NL/feature/TaskScenario_SupportAlte…

…rnativeTaskObjectPOCO

Feature/task scenario support alternative task object poco

Documentation/OMC - Documentation.md

@@ -1,6 +1,6 @@
 # **OMC** Documentation
 
-v.1.8.14
+v.1.8.15
 
 © 2024, Worth Systems.
 

EventsHandler/Api/EventsHandler/Constants/DefaultValues.cs

@@ -12,7 +12,7 @@ internal static class ApiController
         {
             internal const string Route = "[controller]";
 
-            internal const string Version = "1.814";
+            internal const string Version = "1.815";
         }
         #endregion
 

EventsHandler/Api/EventsHandler/Extensions/UriExtensions.cs

@@ -89,7 +89,7 @@ internal static bool IsNotCaseType(this Uri? uri)
         }
 
         /// <summary>
-        /// Determines whether the given <see cref="Uri"/> doesn't contain object (e.g., <see cref="TaskObject"/> or <see cref="MessageObject"/>) <see cref="Uri"/>.
+        /// Determines whether the given <see cref="Uri"/> doesn't contain object (e.g., <see cref="CommonTaskData"/> from Task or <see cref="MessageObject"/>) <see cref="Uri"/>.
         /// </summary>
         /// <param name="uri">The source URI.</param>
         /// <returns>

EventsHandler/Api/EventsHandler/Mapping/Enums/NotificatieApi/Resources.cs

@@ -2,8 +2,6 @@
 
 using EventsHandler.Constants;
 using EventsHandler.Mapping.Converters;
-using EventsHandler.Mapping.Models.POCOs.Objecten.Message;
-using EventsHandler.Mapping.Models.POCOs.Objecten.Task;
 using System.Text.Json.Serialization;
 
 namespace EventsHandler.Mapping.Enums.NotificatieApi

EventsHandler/Api/EventsHandler/Mapping/Enums/Objecten/TaskStatuses.cs

@@ -8,7 +8,7 @@
 namespace EventsHandler.Mapping.Enums.Objecten
 {
     /// <summary>
-    /// The status of the <see cref="TaskObject"/> from "Objecten" Web API service.
+    /// The status of the <see cref="CommonTaskData.Status"/> from "Objecten" Web API service.
     /// </summary>
     [JsonConverter(typeof(SafeJsonStringEnumMemberConverter<TaskStatuses>))]
     public enum TaskStatuses

EventsHandler/Api/EventsHandler/Mapping/Enums/Objecten/vNijmegen/Registrations.cs

@@ -0,0 +1,28 @@
+// © 2024, Worth Systems.
+
+using EventsHandler.Constants;
+using EventsHandler.Mapping.Converters;
+using EventsHandler.Mapping.Models.POCOs.Objecten.Task.vNijmegen;
+using System.Text.Json.Serialization;
+
+namespace EventsHandler.Mapping.Enums.Objecten.vNijmegen
+{
+    /// <summary>
+    /// The type of the <see cref="Coupling"/> from "Objecten" Web API service.
+    /// </summary>
+    [JsonConverter(typeof(SafeJsonStringEnumMemberConverter<Registrations>))]
+    public enum Registrations
+    {
+        /// <summary>
+        /// The default value.
+        /// </summary>
+        [JsonPropertyName(DefaultValues.Models.DefaultEnumValueName)]
+        Unknown = 0,
+
+        /// <summary>
+        /// The case type of the <see cref="Coupling"/>.
+        /// </summary>
+        [JsonPropertyName("zaak")]
+        Case = 1
+    }
+}

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/NotificatieApi/EventAttributes.cs

@@ -89,7 +89,7 @@ internal readonly PropertiesMetadata Properties(Channels channel)
 
         #region Object properties
         /// <summary>
-        /// The <see cref="TaskObject"/> or <see cref="MessageObject"/> type in <see cref="Uri"/> format:
+        /// The <see cref="CommonTaskData"/> from Task or <see cref="MessageObject"/> type in <see cref="Uri"/> format:
         /// <code>
         /// http(s)://Domain/ApiEndpoint/[UUID]
         /// </code>

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Identification.cs

@@ -9,7 +9,7 @@
 namespace EventsHandler.Mapping.Models.POCOs.Objecten
 {
     /// <summary>
-    /// The identification related to the different Data (associated with <see cref="TaskObject"/>,
+    /// The identification related to the different Data (associated with <see cref="CommonTaskData"/> from Task,
     /// <see cref="MessageObject"/>, etc.) retrieved from "Objecten" Web API service.
     /// </summary>
     /// <seealso cref="IJsonSerializable"/>

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/CommonTaskData.cs

@@ -0,0 +1,68 @@
+// © 2024, Worth Systems.
+
+using EventsHandler.Mapping.Enums.Objecten;
+using EventsHandler.Mapping.Models.Interfaces;
+using System.Text.Json.Serialization;
+
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task
+{
+    /// <summary>
+    /// The data related to the Task (from vHague or vNijmegen versions) retrieved from "Objecten" Web API service.
+    /// </summary>
+    /// <remarks>
+    ///   Common DTO for all versions of "Objecten" Web API service.
+    /// </remarks>
+    /// <seealso cref="IJsonSerializable"/>
+    internal readonly struct CommonTaskData : IJsonSerializable
+    {
+        /// <summary>
+        /// The reference to related object in <see cref="System.Uri"/> format:
+        /// <code>
+        /// http(s)://Domain/ApiEndpoint/[UUID]
+        /// </code>
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyOrder(0)]
+        internal Uri CaseUri { get; init; }  // NOTE: Some task data might not have it (recreating of URI is necessary)
+
+        /// <summary>
+        /// The ID of the related object.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyOrder(1)]
+        internal Guid CaseId { get; init; }
+
+        /// <summary>
+        /// The title of the task.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyOrder(2)]
+        internal string Title { get; init; }
+
+        /// <summary>
+        /// The status of the task.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyOrder(3)]
+        internal TaskStatuses Status { get; init; }
+
+        /// <summary>
+        /// The deadline by which the task should be completed.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyOrder(4)]
+        internal DateTime ExpirationDate { get; init; }
+
+        /// <summary>
+        /// The identification details of the task.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyOrder(5)]
+        internal Identification Identification { get; init; }
+    }
+}

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/Converters/CommonTaskDataConverter.cs

@@ -0,0 +1,60 @@
+// © 2024, Worth Systems.
+
+using EventsHandler.Extensions;
+using EventsHandler.Services.Settings.Extensions;
+using ConfigurationExtensions = EventsHandler.Services.Settings.Extensions.ConfigurationExtensions;
+
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task.Converters
+{
+    /// <summary>
+    /// Converts task data from different versions of "Objecten" into a unified <see cref="CommonTaskData"/>.
+    /// </summary>
+    internal static class CommonTaskDataConverter
+    {
+        /// <summary>
+        /// Converts <see cref="vHague.TaskObject"/> (version used by The Hague) from "Objecten" Web API service.
+        /// </summary>
+        /// <returns>
+        ///   The unified <see cref="CommonTaskData"/> DTO model.
+        /// </returns>
+        internal static CommonTaskData ConvertToUnified(this vHague.TaskObject taskDataHague)
+        {
+            return new CommonTaskData
+            {
+                CaseUri        = taskDataHague.Record.Data.CaseUri,
+                CaseId         = taskDataHague.Record.Data.CaseUri.GetGuid(),  // NOTE: URI is given, GUID needs to be extracted
+                Title          = taskDataHague.Record.Data.Title,
+                Status         = taskDataHague.Record.Data.Status,
+                ExpirationDate = taskDataHague.Record.Data.ExpirationDate,
+                Identification = taskDataHague.Record.Data.Identification
+            };
+        }
+
+        /// <summary>
+        /// Converts <see cref="vNijmegen.TaskObject"/> (version used by Nijmegen) from "Objecten" Web API service.
+        /// </summary>
+        /// <returns>
+        ///   The unified <see cref="CommonTaskData"/> DTO model.
+        /// </returns>
+        internal static CommonTaskData ConvertToUnified(this vNijmegen.TaskObject taskNijmegen)
+        {
+            return new CommonTaskData
+            {
+                CaseUri        = RecreateCaseUri(taskNijmegen.Record.Data.Coupling.Id),  // NOTE: GUID is given, URI needs to be recreated
+                CaseId         = taskNijmegen.Record.Data.Coupling.Id,
+                Title          = taskNijmegen.Record.Data.Title,
+                Status         = taskNijmegen.Record.Data.Status,
+                ExpirationDate = taskNijmegen.Record.Data.ExpirationDate,
+                Identification = taskNijmegen.Record.Data.Identification
+            };
+        }
+
+        #region Helper methods
+        private const string CaseUri = "https://{0}/zaken/api/v1/zaken/{1}";
+
+        private static Uri RecreateCaseUri(Guid caseId)
+            => string.Format(CaseUri, ConfigurationExtensions.OpenZaakDomain(), caseId)
+                     .GetValidUri();
+        #endregion
+    }
+}

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/Data.cs → EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/vHague/Data.cs

@@ -3,59 +3,49 @@
 using EventsHandler.Constants;
 using EventsHandler.Mapping.Enums.Objecten;
 using EventsHandler.Mapping.Models.Interfaces;
-using EventsHandler.Mapping.Models.POCOs.OpenZaak;
 using System.Text.Json.Serialization;
 
-namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task.vHague
 {
     /// <summary>
     /// The data related to the <see cref="Record"/> retrieved from "Objecten" Web API service.
     /// </summary>
+    /// <remarks>
+    ///   Version used by The Hague.
+    /// </remarks>
+    /// <seealso cref="CommonTaskData"/>
     /// <seealso cref="IJsonSerializable"/>
     public struct Data : IJsonSerializable
     {
-        /// <summary>
-        /// The reference to <see cref="Case"/> in <see cref="Uri"/> format:
-        /// <code>
-        /// http(s)://Domain/ApiEndpoint/[UUID]
-        /// </code>
-        /// </summary>
+        /// <inheritdoc cref="CommonTaskData.CaseId"/>
         [JsonRequired]
         [JsonInclude]
         [JsonPropertyName("zaak")]
         [JsonPropertyOrder(0)]
         public Uri CaseUri { get; internal set; } = DefaultValues.Models.EmptyUri;
 
-        /// <summary>
-        /// The title of the <see cref="TaskObject"/>.
-        /// </summary>
+        /// <inheritdoc cref="CommonTaskData.Title"/>
         [JsonRequired]
         [JsonInclude]
         [JsonPropertyName("title")]
         [JsonPropertyOrder(1)]
         public string Title { get; internal set; } = string.Empty;
 
-        /// <summary>
-        /// The status of the <see cref="TaskObject"/>.
-        /// </summary>
+        /// <inheritdoc cref="CommonTaskData.Status"/>
         [JsonRequired]
         [JsonInclude]
         [JsonPropertyName("status")]
         [JsonPropertyOrder(2)]
         public TaskStatuses Status { get; internal set; }
 
-        /// <summary>
-        /// The deadline by which the <see cref="TaskObject"/> should be completed.
-        /// </summary>
+        /// <inheritdoc cref="CommonTaskData.ExpirationDate"/>
         [JsonRequired]
         [JsonInclude]
         [JsonPropertyName("verloopdatum")]
         [JsonPropertyOrder(3)]
         public DateTime ExpirationDate { get; internal set; }
 
-        /// <summary>
-        /// The identification details of the <see cref="TaskObject"/>.
-        /// </summary>
+        /// <inheritdoc cref="CommonTaskData.Identification"/>
         [JsonRequired]
         [JsonInclude]
         [JsonPropertyName("identificatie")]

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/Record.cs → EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/vHague/Record.cs

@@ -3,11 +3,14 @@
 using EventsHandler.Mapping.Models.Interfaces;
 using System.Text.Json.Serialization;
 
-namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task.vHague
 {
     /// <summary>
     /// The record related to the <see cref="TaskObject"/> retrieved from "Objecten" Web API service.
     /// </summary>
+    /// <remarks>
+    ///   Version used by The Hague.
+    /// </remarks>
     /// <seealso cref="IJsonSerializable"/>
     public struct Record : IJsonSerializable
     {

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/TaskObject.cs → EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/vHague/TaskObject.cs

@@ -3,11 +3,14 @@
 using EventsHandler.Mapping.Models.Interfaces;
 using System.Text.Json.Serialization;
 
-namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task.vHague
 {
     /// <summary>
     /// The task retrieved from "Objecten" Web API service.
     /// </summary>
+    /// <remarks>
+    ///   Version used by The Hague.
+    /// </remarks>
     /// <seealso cref="IJsonSerializable"/>
     public struct TaskObject : IJsonSerializable
     {

EventsHandler/Api/EventsHandler/Mapping/Models/POCOs/Objecten/Task/vNijmegen/Coupling.cs

@@ -0,0 +1,40 @@
+// © 2024, Worth Systems.
+
+using EventsHandler.Mapping.Enums.Objecten.vNijmegen;
+using EventsHandler.Mapping.Models.Interfaces;
+using System.Text.Json.Serialization;
+
+namespace EventsHandler.Mapping.Models.POCOs.Objecten.Task.vNijmegen
+{
+    /// <summary>
+    /// The coupling related to the <see cref="TaskObject"/> retrieved from "Objecten" Web API service.
+    /// </summary>
+    /// <seealso cref="IJsonSerializable"/>
+    public struct Coupling : IJsonSerializable
+    {
+        /// <summary>
+        /// The type of the <see cref="Coupling"/>.
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyName("registratie")]
+        [JsonPropertyOrder(0)]
+        public Registrations Type { get; internal set; }
+
+        /// <summary>
+        /// The ID of the <see cref="Coupling"/> object (e.g., case).
+        /// </summary>
+        [JsonRequired]
+        [JsonInclude]
+        [JsonPropertyName("uuid")]
+        [JsonPropertyOrder(1)]
+        public Guid Id { get; internal set; } = Guid.Empty;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Coupling"/> struct.
+        /// </summary>
+        public Coupling()
+        {
+        }
+    }
+}