Task api enhancement to include attachment and comments fields.

engine-rest/engine-rest-openapi/src/main/templates/lib/commons/task-query-params.ftl

@@ -657,5 +657,12 @@
   <@lib.parameter name = "parentTaskId"
       location = "query"
       type = "string"
+      desc = "Restrict query to all tasks that are sub tasks of the given task. Takes a task id." />
+
+  <@lib.parameter name = "withCommentAttachmentInfo"
+      location = "query"
+      type = "boolean"
+      defaultValue = "false"
       last = last
-      desc = "Restrict query to all tasks that are sub tasks of the given task. Takes a task id." />
+      desc = "Check if task has attachments and/or comments. Value may only be `true`, as
+                  `false` is the default behavior." />

engine-rest/engine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/runtime/task/TaskDto.ftl

@@ -129,8 +129,18 @@
     <@lib.property
         name = "tenantId"
         type = "string"
-        last = true
         desc = "If not `null`, the tenant id of the task." />
 
+    <@lib.property
+        name = "attachment"
+        type = "boolean"
+        desc = "Specifies if an attachment exists for the task." />
+
+    <@lib.property
+        name = "comment"
+        type = "boolean"
+        last = true
+        desc = "Specifies if an comment exists for the task." />
+
 </@lib.dto>
 </#macro>

engine-rest/engine-rest-openapi/src/main/templates/paths/task/get.ftl

@@ -68,7 +68,9 @@
                              "binding": "version",
                              "version": 2
                            },
-                           "tenantId": "aTenantId"
+                           "tenantId": "aTenantId",
+                           "attachments":false,
+                           "comments":false
                          }
                        ]
                      }'] />

engine-rest/engine-rest-openapi/src/main/templates/paths/task/post.ftl

@@ -119,7 +119,9 @@
                              "binding": "version",
                              "version": 2
                            },
-                           "tenantId":"aTenantId"
+                           "tenantId":"aTenantId",
+                           "attachments":false,
+                           "comments":false
                          }
                        ]
                     }',
@@ -148,7 +150,9 @@
                            "caseDefinitionId": null,
                            "suspended": false,
                            "formKey": "embedded:app:develop/invoice-forms/approve-invoice.html",
-                           "tenantId": null
+                           "tenantId": null,
+                           "attachments":false,
+                           "comments":false
                          }
                        ]
                      }'

engine-rest/engine-rest-openapi/src/main/templates/paths/task/{id}/get.ftl

@@ -53,7 +53,9 @@
                            "binding": "version",
                            "version": 2
                          },
-                         "tenantId":"aTenantId"
+                         "tenantId":"aTenantId",
+                         "attachments":false,
+                         "comments":false
                        }
                      }'] />
 

engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/task/TaskDto.java

@@ -49,7 +49,8 @@ public class TaskDto {
   private String formKey;
   private CamundaFormRef camundaFormRef;
   private String tenantId;
-
+  private boolean attachments;
+  private boolean comments;
   public String getId() {
     return id;
   }
@@ -194,6 +195,21 @@ public void setTenantId(String tenantId) {
     this.tenantId = tenantId;
   }
 
+  public boolean getAttachments() {
+    return attachments;
+  }
+  public void setAttachments(boolean attachments) {
+    this.attachments = attachments;
+  }
+
+  public boolean isComments() {
+    return comments;
+  }
+
+  public void setComments(boolean comments) {
+    this.comments = comments;
+  }
+
   public static TaskDto fromEntity(Task task) {
     TaskDto dto = new TaskDto();
     dto.id = task.getId();
@@ -221,6 +237,8 @@ public static TaskDto fromEntity(Task task) {
     dto.caseInstanceId = task.getCaseInstanceId();
     dto.suspended = task.isSuspended();
     dto.tenantId = task.getTenantId();
+    dto.attachments = task.getAttachments();
+    dto.comments = task.getComments();
 
     try {
       dto.formKey = task.getFormKey();

engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/task/TaskQueryDto.java

@@ -212,6 +212,8 @@ public class TaskQueryDto extends AbstractQueryDto<TaskQuery> {
 
   private List<TaskQueryDto> orQueries;
 
+  private Boolean withCommentAttachmentInfo;
+
   public TaskQueryDto() {
 
   }
@@ -708,6 +710,11 @@ public void setVariableValuesIgnoreCase(Boolean variableValuesCaseInsensitive) {
     this.variableValuesIgnoreCase = variableValuesCaseInsensitive;
   }
 
+  @CamundaQueryParam(value = "withCommentAttachmentInfo", converter = BooleanConverter.class)
+  public void setWithCommentAttachmentInfo(Boolean withCommentAttachmentInfo) {
+    this.withCommentAttachmentInfo = withCommentAttachmentInfo;
+  }
+
   @Override
   protected boolean isValidSortByValue(String value) {
     return VALID_SORT_BY_VALUES.contains(value);
@@ -1078,6 +1085,8 @@ public Boolean isVariableValuesIgnoreCase() {
     return variableValuesIgnoreCase;
   }
 
+  public Boolean getWithCommentAttachmentInfo() { return withCommentAttachmentInfo;}
+
   @Override
   protected void applyFilters(TaskQuery query) {
     if (orQueries != null) {
@@ -1442,6 +1451,9 @@ protected void applyFilters(TaskQuery query) {
         }
       }
     }
+    if (withCommentAttachmentInfo != null && withCommentAttachmentInfo) {
+      query.withCommentAttachmentInfo();
+    }
   }
 
   @Override

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TaskRestServiceInteractionTest.java

@@ -313,6 +313,8 @@ public void testGetSingleTask() {
       .body("caseDefinitionId", equalTo(MockProvider.EXAMPLE_CASE_DEFINITION_ID))
       .body("tenantId", equalTo(MockProvider.EXAMPLE_TENANT_ID))
       .body("lastUpdated", equalTo(MockProvider.EXAMPLE_TASK_LAST_UPDATED))
+      .body("attachments", equalTo(MockProvider.EXAMPLE_TASK_ATTACHMENT_STATE))
+      .body("comments", equalTo(MockProvider.EXAMPLE_TASK_COMMENT_STATE))
       .when().get(SINGLE_TASK_URL);
   }
 

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TaskRestServiceQueryTest.java

@@ -187,6 +187,8 @@ public void testSimpleTaskQuery() {
     boolean returnedSuspensionState = from(content).getBoolean("[0].suspended");
     String returnedFormKey = from(content).getString("[0].formKey");
     String returnedTenantId = from(content).getString("[0].tenantId");
+    boolean returnedAttachmentsInfo = from(content).getBoolean("[0].attachments");
+    boolean returnedCommentsInfo = from(content).getBoolean("[0].comments");
 
     assertThat(MockProvider.EXAMPLE_TASK_NAME).isEqualTo(returnedTaskName);
     assertThat(MockProvider.EXAMPLE_TASK_ID).isEqualTo(returnedId);
@@ -210,6 +212,8 @@ public void testSimpleTaskQuery() {
     assertThat(MockProvider.EXAMPLE_TASK_SUSPENSION_STATE).isEqualTo(returnedSuspensionState);
     assertThat(MockProvider.EXAMPLE_FORM_KEY).isEqualTo(returnedFormKey);
     assertThat(MockProvider.EXAMPLE_TENANT_ID).isEqualTo(returnedTenantId);
+    assertThat(MockProvider.EXAMPLE_TASK_ATTACHMENT_STATE).isEqualTo(returnedAttachmentsInfo);
+    assertThat(MockProvider.EXAMPLE_TASK_COMMENT_STATE).isEqualTo(returnedCommentsInfo);
 
   }
 
@@ -521,6 +525,7 @@ private Map<String, Boolean> getCompleteBooleanQueryParameters() {
     parameters.put("withCandidateUsers", true);
     parameters.put("withoutCandidateUsers", true);
     parameters.put("withoutDueDate", true);
+    parameters.put("withCommentAttachmentInfo", true);
 
     return parameters;
   }
@@ -586,6 +591,7 @@ private void verifyBooleanParameterQueryInvocation() {
     verify(mockQuery).withCandidateUsers();
     verify(mockQuery).withoutCandidateUsers();
     verify(mockQuery).withoutDueDate();
+    verify(mockQuery).withCommentAttachmentInfo();
   }
 
   @Test

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java

@@ -195,6 +195,10 @@ public abstract class MockProvider {
   public static final String EXAMPLE_TASK_DEFINITION_KEY = "aTaskDefinitionKey";
   public static final boolean EXAMPLE_TASK_SUSPENSION_STATE = false;
 
+  public static final boolean EXAMPLE_TASK_ATTACHMENT_STATE = false;
+
+  public static final boolean EXAMPLE_TASK_COMMENT_STATE = false;
+
   // task comment
   public static final String EXAMPLE_TASK_COMMENT_ID = "aTaskCommentId";
   public static final String EXAMPLE_TASK_COMMENT_FULL_MESSAGE = "aTaskCommentFullMessage";
@@ -1055,7 +1059,9 @@ public static MockTaskBuilder mockTask() {
       .caseExecutionId(EXAMPLE_CASE_EXECUTION_ID)
       .formKey(EXAMPLE_FORM_KEY)
       .camundaFormRef(EXAMPLE_FORM_KEY, EXAMPLE_FORM_REF_BINDING, EXAMPLE_FORM_REF_VERSION)
-      .tenantId(EXAMPLE_TENANT_ID);
+      .tenantId(EXAMPLE_TENANT_ID)
+      .attachments(EXAMPLE_TASK_ATTACHMENT_STATE)
+      .comments(EXAMPLE_TASK_COMMENT_STATE);
   }
 
   public static List<Task> createMockTasks() {

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockTaskBuilder.java

@@ -50,6 +50,10 @@ public class MockTaskBuilder {
   private String formKey;
   private CamundaFormRef camundaFormRef;
   private String tenantId;
+  private boolean attachments;
+  private boolean comments;
+
+
 
   public MockTaskBuilder id(String id) {
     this.id = id;
@@ -163,6 +167,16 @@ public MockTaskBuilder tenantId(String tenantId) {
     return this;
   }
 
+  public MockTaskBuilder attachments(boolean hasAttachments) {
+    this.attachments = hasAttachments;
+    return this;
+  }
+
+  public MockTaskBuilder comments(boolean hasComments) {
+    this.comments = hasComments;
+    return this;
+  }
+
   public Task build() {
     Task mockTask = mock(Task.class);
     when(mockTask.getId()).thenReturn(id);
@@ -187,6 +201,8 @@ public Task build() {
     when(mockTask.getFormKey()).thenReturn(formKey);
     when(mockTask.getCamundaFormRef()).thenReturn(camundaFormRef);
     when(mockTask.getTenantId()).thenReturn(tenantId);
+    when(mockTask.getAttachments()).thenReturn(attachments);
+    when(mockTask.getComments()).thenReturn(comments);
     return mockTask;
   }
 

engine/src/main/java/org/camunda/bpm/engine/impl/TaskQueryImpl.java

@@ -44,6 +44,7 @@
 import org.camunda.bpm.engine.task.Task;
 import org.camunda.bpm.engine.task.TaskQuery;
 import org.camunda.bpm.engine.variable.type.ValueType;
+import org.camunda.bpm.engine.impl.history.HistoryLevel;
 
 /**
  * @author Joram Barrez
@@ -175,6 +176,7 @@ public class TaskQueryImpl extends AbstractQuery<TaskQuery, Task> implements Tas
   // or query /////////////////////////////
   protected List<TaskQueryImpl> queries = new ArrayList<>(Arrays.asList(this));
   protected boolean isOrQueryActive = false;
+  protected boolean withCommentAttachmentInfo = false;
 
   public TaskQueryImpl() {
   }
@@ -1088,6 +1090,12 @@ protected boolean hasExcludingConditions() {
       || CompareUtil.elementIsNotContainedInArray(processInstanceBusinessKey, processInstanceBusinessKeys);
   }
 
+  @Override
+  public TaskQuery withCommentAttachmentInfo() {
+    this.withCommentAttachmentInfo = true;
+    return this;
+  }
+
   public List<String> getCandidateGroups() {
     if (cachedCandidateGroups != null) {
       return cachedCandidateGroups;
@@ -1441,6 +1449,13 @@ public List<Task> executeList(CommandContext commandContext, Page page) {
       }
     }
 
+    if (withCommentAttachmentInfo && Context.getProcessEngineConfiguration().getHistoryLevel()!= HistoryLevel.HISTORY_LEVEL_NONE) {
+      for (Task task : taskList) {
+        // verify attachment and comments exists for the task
+        ((TaskEntity) task).initializeAttachmentAndComments();
+      }
+    }
+
     return taskList;
   }
 

engine/src/main/java/org/camunda/bpm/engine/impl/persistence/entity/TaskEntity.java

@@ -158,6 +158,8 @@ public class TaskEntity extends AbstractVariableScope implements Task, DelegateT
   protected boolean isFormKeyInitialized = false;
   protected String formKey;
   protected CamundaFormRef camundaFormRef;
+  protected boolean attachmentExists;
+  protected boolean commentExists;
 
   @SuppressWarnings({ "unchecked" })
   protected transient VariableStore<VariableInstanceEntity> variableStore
@@ -1451,6 +1453,10 @@ public void initializeFormKey() {
       }
     }
   }
+  public void initializeAttachmentAndComments(){
+    this.attachmentExists = !getProcessEngine().getTaskService().getTaskAttachments(id).isEmpty();
+    this.commentExists = !getProcessEngine().getTaskService().getTaskComments(id).isEmpty();
+  }
 
   @Override
   public String getFormKey() {
@@ -1758,7 +1764,14 @@ public void bpmnError(String errorCode, String errorMessage, Map<String, Object>
       throw ProcessEngineLogger.CMD_LOGGER.exceptionBpmnErrorPropagationFailed(errorCode, ex);
     }
   }
-
+  @Override
+  public boolean getAttachments() {
+    return attachmentExists;
+  }
+  @Override
+  public boolean getComments() {
+    return commentExists;
+  }
   public void escalation(String escalationCode, Map<String, Object> variables) {
     ensureTaskActive();
     ActivityExecution activityExecution = getExecution();

engine/src/main/java/org/camunda/bpm/engine/task/Task.java

@@ -189,4 +189,9 @@ public interface Task {
    */
   void setTenantId(String tenantId);
 
+  /** Returns if an attachment exists for the task */
+  boolean getAttachments();
+  /** Signifies if a comment exists for the task */
+  boolean getComments();
+
 }

engine/src/main/java/org/camunda/bpm/engine/task/TaskQuery.java

@@ -1104,4 +1104,9 @@ public interface TaskQuery extends Query<TaskQuery, Task> {
    *                                this exception, {@link #or()} must be invoked first.
    */
   TaskQuery endOr();
+
+  /**
+   * Evaluates existence of attachment and comments associated with the task, defaults to false.
+   */
+  TaskQuery withCommentAttachmentInfo();
 }