com.almworks.jira.structure.api.template.NewStructureTemplateStep Maven / Gradle / Ivy

Go to download

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

Public API for the Structure Plugin for JIRA

There is a newer version: 17.25.3

package com.almworks.jira.structure.api.template;

import org.jetbrains.annotations.NotNull;

import java.util.Map;

/**
 * @author alexeypegov
 */
public interface NewStructureTemplateStep {
  String END_STEP = "__end";
  String START_STEP = "__start";
  String CREATE_STRUCTURE = "__create"; // should be returned as a next step to trigger structure creation

  enum Direction {
    FORWARD,
    BACK;

    public boolean isBack() {
      return this == BACK;
    }
  }

  @NotNull
  String getTitleI18nKey();

  void validateStep(@NotNull Map params, @NotNull NewStructureTemplateContext context);

  @NotNull
  String getNextStep(@NotNull Map params, @NotNull Direction direction, @NotNull NewStructureTemplateContext context);
}