Implement null support for displayOnCreate field option

Saixel · Saixel · commit 15fc52ce8ad1 · 2025-03-06T19:23:37.000Z
- Change displayOnCreate to nullable Boolean in DatasetFieldType
- Update API and service methods to handle null displayOnCreate values
- Modify native API documentation to explain null displayOnCreate behavior
- Add null checks in MetadataBlockServiceBean queries
diff --git a/doc/sphinx-guides/source/api/native-api.rst b/doc/sphinx-guides/source/api/native-api.rst
@@ -1117,7 +1117,7 @@ This endpoint expects a JSON with the following format::
       "datasetFieldTypeName": "datasetFieldTypeName1",
       "required": true,
       "include": true,
-      "displayOnCreate": false  // Note: This setting is ignored for required fields
+      "displayOnCreate": null
     },
     {
       "datasetFieldTypeName": "datasetFieldTypeName2",
@@ -1129,6 +1129,7 @@ This endpoint expects a JSON with the following format::
 
 .. note::
    Required fields will always be displayed regardless of their displayOnCreate setting, as this is necessary for dataset creation.
+   When displayOnCreate is null, the field's default display behavior is used.
 
 Parameters:
 
diff --git a/src/main/java/edu/harvard/iq/dataverse/DatasetFieldType.java b/src/main/java/edu/harvard/iq/dataverse/DatasetFieldType.java
@@ -273,14 +273,14 @@ public void setValidationFormat(String validationFormat) {
      * Determines whether this field type is displayed in the form when creating
      * the Dataset (or only later when editing after the initial creation).
      */
-    @Column(name = "displayoncreate", nullable = false)
-    private boolean displayOnCreate;
+    @Column(name = "displayoncreate", nullable = true)
+    private Boolean displayOnCreate;
 
-    public boolean isDisplayOnCreate() {
+    public Boolean isDisplayOnCreate() {
         return displayOnCreate;
     }
 
-    public void setDisplayOnCreate(boolean displayOnCreate) {
+    public void setDisplayOnCreate(Boolean displayOnCreate) {
         this.displayOnCreate = displayOnCreate;
     }
     
diff --git a/src/main/java/edu/harvard/iq/dataverse/MetadataBlockServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/MetadataBlockServiceBean.java
@@ -72,6 +72,7 @@ public List<MetadataBlock> listMetadataBlocksDisplayedOnCreate(Dataverse ownerDa
             // Predicate for displayOnCreate in the input level
             Predicate displayOnCreateInputLevelPredicate = criteriaBuilder.and(
                 datasetFieldTypeInputLevelJoin.get("datasetFieldType").in(metadataBlockRoot.get("datasetFieldTypes")),
+                criteriaBuilder.isNotNull(datasetFieldTypeInputLevelJoin.get("displayOnCreate")),
                 criteriaBuilder.isTrue(datasetFieldTypeInputLevelJoin.get("displayOnCreate")));
 
             // Predicate for required fields
@@ -82,6 +83,7 @@ public List<MetadataBlock> listMetadataBlocksDisplayedOnCreate(Dataverse ownerDa
             // Predicate for default displayOnCreate (when there is no input level)
             Predicate defaultDisplayOnCreatePredicate = criteriaBuilder.and(
                 criteriaBuilder.not(criteriaBuilder.exists(inputLevelSubquery)),
+                criteriaBuilder.isNotNull(datasetFieldTypeJoin.get("displayOnCreate")),
                 criteriaBuilder.isTrue(datasetFieldTypeJoin.get("displayOnCreate")));
 
             Predicate unionPredicate = criteriaBuilder.or(
diff --git a/src/main/java/edu/harvard/iq/dataverse/api/DatasetFieldServiceApi.java b/src/main/java/edu/harvard/iq/dataverse/api/DatasetFieldServiceApi.java
@@ -551,7 +551,7 @@ public static String getDataverseLangDirectory() {
      */
     @POST
     @Path("/setDisplayOnCreate")
-    public Response setDisplayOnCreate(@QueryParam("datasetFieldType") String datasetFieldTypeIn, @QueryParam("setDisplayOnCreate") boolean setDisplayOnCreateIn) {
+    public Response setDisplayOnCreate(@QueryParam("datasetFieldType") String datasetFieldTypeIn, @QueryParam("setDisplayOnCreate") Boolean setDisplayOnCreateIn) {
         DatasetFieldType dft = datasetFieldService.findByName(datasetFieldTypeIn);
         if (dft == null) {
             return error(Status.NOT_FOUND, "Cound not find a DatasetFieldType by looking up " + datasetFieldTypeIn);
