/*
    * Copyright (c) 2023. Roland T. Lichti, Kaiserpfalz EDV-Service.
    *
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
    * the Free Software Foundation, either version 3 of the License, or
    * (at your option) any later version.
    *
    * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program.  If not, see <https://www.gnu.org/licenses/>.
   */
  
  package de.kaiserpfalzedv.commons.core.workflow;
  
  import java.util.UUID;
  
  import org.eclipse.microprofile.openapi.annotations.media.Schema;
  
  import com.fasterxml.jackson.annotation.JsonInclude;
  
  import de.kaiserpfalzedv.commons.api.workflow.WorkflowInfo;
  import jakarta.annotation.Nullable;
  import jakarta.validation.constraints.NotNull;
  import lombok.AllArgsConstructor;
  import lombok.Builder;
  import lombok.EqualsAndHashCode;
  import lombok.Getter;
  import lombok.NoArgsConstructor;
  import lombok.ToString;
  import lombok.extern.jackson.Jacksonized;
  
  /**
   * WorkflowInfo -- Default workflow information of a request.
   *
   * This info should be generated on the northbound interface of a system. It should be passed to other system calls.
   * Normally as out-of-band information. So the encoding may change (HTTP-Headers, JMS properties, ...).
   *
   * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
   * @since 2.0.0  2022-01-04
   */
  @Jacksonized
  @Builder(toBuilder = true)
  @AllArgsConstructor
  @NoArgsConstructor
  @ToString
  @EqualsAndHashCode
  @Getter
  @JsonInclude(JsonInclude.Include.NON_ABSENT)
  @Schema(name = "WorkflowInfo", description = "Information of a workflow call.")
  public class WorkflowInfoImpl implements WorkflowInfo {
      private static final long serialVersionUID = 0L;
  
      @Schema(
          description = "The complete (perhaps even long running) workflow",
          required = false
      )
      @Builder.Default
      @Nullable
      private final WorkflowDetailInfoImpl workflow = WorkflowDetailInfoImpl.builder().build();
  
      @Schema(
              description = "The action within the workflow this call belongs to.",
              required = true
      )
      @NotNull
      @Builder.Default
      private final WorkflowDetailInfoImpl action = WorkflowDetailInfoImpl.builder().build();
  
      @Schema(
              description = "The actual service call.",
              required = true
      )
      @NotNull
      @Builder.Default
      private final WorkflowDetailInfoImpl call = WorkflowDetailInfoImpl.builder().build();
  
      @Schema(
              description = "The owner of this request. Can be an ID, a name or anything else. Please keep GDPR in mind!",
              defaultValue = "A random UUID",
              required = false,
              minLength = 1,
              maxLength = 100
      )
      @Nullable
      @Builder.Default
      private final String user = UUID.randomUUID().toString();
  }