com.nitorcreations.nflow.rest.v1.msg.State Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nflow-rest-api Show documentation

nFlow REST API

There is a newer version: 3.3.0

package com.nitorcreations.nflow.rest.v1.msg;

import java.util.LinkedHashSet;
import java.util.Set;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(description = "Workflow definition states and transition to next states")
@SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD", justification = "jackson reads dto fields")
public class State {

  public State() {
    // default constructor for Jackson deserializer
  }

  public State(String id, String type, String description) {
    this.id = id;
    this.type = type;
    this.description = description;
  }

  @ApiModelProperty(value = "State identifier", required = true)
  public String id;

  @ApiModelProperty(value = "State type (start, normal, manual, end)", required = true)
  public String type;

  @ApiModelProperty(value = "State description", required = true)
  public String description;

  @ApiModelProperty("Permitted transitions from this state")
  public Set transitions = new LinkedHashSet<>();

  @ApiModelProperty("Failure state for the this state")
  public String onFailure;
}