com.almworks.jira.structure.api.process.ProcessFeedback 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

The newest version!

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

import org.jetbrains.annotations.NotNull;

/**
 * ProcessFeedback allows communication between process owner and process itself.
 *
 * If you know processId, you can access its feedback using {@link ProcessHandleManager#getFeedback(Long)} method.
 */
public interface ProcessFeedback {
  /**
   * Updates process status
   * @param status New status to be set
   * todo state that it's not exception-free
   */
  void setStatus(@NotNull ProcessStatus status);

  /**
   * @return {@code true} if the process has been asked to stop with {@link ProcessInfo#cancel()}
   */
  boolean isCancelled();
}