chore: Add option to get the UID type of a UIDObject (#22875)

* chore: Add option to get the UID type of a UIDObject

* format

* chore: Update method name & add deprecation info

Author: david-mackessy

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/UidObject.java

@@ -39,8 +39,16 @@
  */
 public interface UidObject {
   /**
-   * @return external unique ID of the object as used in the RESTful API
+   * @deprecated This method is being phased out in favour of {@link #getUID()} which provides type
+   *     safety, validation and security bonuses. Please use {@link #getUID()} instead.
+   * @return external unique ID of the object as used in the RESTful API web api backward
+   *     compatibility
    */
+  @Deprecated(since = "2.43")
   @JsonProperty(value = "id")
   String getUid();
+
+  default UID getUID() {
+    return UID.of(getUid());
+  }
 }

dhis-2/dhis-api/src/test/java/org/hisp/dhis/common/UidObjectTest.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2004-2026, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors 
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.common;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.hisp.dhis.category.Category;
+import org.junit.jupiter.api.Test;
+
+class UidObjectTest {
+
+  @Test
+  void getUIDTest() {
+    Category category = new Category();
+    category.setAutoFields();
+    UID uidType = category.getUID();
+    assertEquals(category.getUid(), uidType.getValue());
+  }
+}