pro.taskana.task.rest.models.TaskRepresentationModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of taskana-rest-spring Show documentation
The taskana rest logic.
The newest version!
package pro.taskana.task.rest.models;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map.Entry;
import pro.taskana.task.api.models.Task;

@Schema(description = "EntityModel class for Task")
@JsonIgnoreProperties("attachmentSummaries")
public class TaskRepresentationModel extends TaskSummaryRepresentationModel {

  // All objects have to be serializable
  @Schema(name = "customAttributes", description = "Additional information of the task.")
  private List customAttributes = Collections.emptyList();

  @Schema(name = "callbackInfo", description = "Callback Information of the task.")
  private List callbackInfo = Collections.emptyList();

  @Schema(name = "attachments", description = "Attachments of the task.")
  private List attachments = new ArrayList<>();

  public List getCustomAttributes() {
    return customAttributes;
  }

  public void setCustomAttributes(List customAttributes) {
    this.customAttributes = customAttributes;
  }

  public List getCallbackInfo() {
    return callbackInfo;
  }

  public void setCallbackInfo(List callbackInfo) {
    this.callbackInfo = callbackInfo;
  }

  public List getAttachments() {
    return attachments;
  }

  public void setAttachments(List attachments) {
    this.attachments = attachments;
  }

  /**
   * A CustomAttribute is a user customized attribute which is saved as a Map and can be retreived
   * from either {@link Task#getCustomAttributeMap()} or {@link Task#getCallbackInfo()}.
   */
  @Schema(description = "A CustomAttribute is a user customized attribute which is saved as a Map.")
  public static class CustomAttribute {

    @Schema(name = "key", description = "the key of the custom attribute.")
    private String key;
    @Schema(name = "value", description = "the value of the custom attribute.")
    private String value;

    public static CustomAttribute of(Entry entry) {
      return of(entry.getKey(), entry.getValue());
    }

    public static CustomAttribute of(String key, String value) {
      CustomAttribute customAttribute = new CustomAttribute();
      customAttribute.setKey(key);
      customAttribute.setValue(value);
      return customAttribute;
    }

    public String getKey() {
      return key;
    }

    public void setKey(String key) {
      this.key = key;
    }

    public String getValue() {
      return value;
    }

    public void setValue(String value) {
      this.value = value;
    }
  }
}