Package io.jenkins.plugins.interactiveinput.view

Enum Class ReviewStatus

java.lang.Object
java.lang.Enum<ReviewStatus>
io.jenkins.plugins.interactiveinput.view.ReviewStatus
All Implemented Interfaces:
Serializable, Comparable<ReviewStatus>, Constable
public enum ReviewStatus extends Enum<ReviewStatus>
Lifecycle state of an interactiveView review document.

A document starts OPEN. A reviewer decision moves it to APPROVED, REJECTED, ACKNOWLEDGED or CHANGES_REQUESTED; a blocking (wait:true) view whose SLA elapses moves to EXPIRED. All states other than OPEN are terminal decisions and resolve a paused pipeline step.

  • Enum Constant Details

    • OPEN

      public static final ReviewStatus OPEN
      Published for review; no decision recorded yet (comments/edits are still allowed).

    • APPROVED

      public static final ReviewStatus APPROVED
      A reviewer approved the report.

    • REJECTED

      public static final ReviewStatus REJECTED
      A reviewer rejected the report.

    • ACKNOWLEDGED

      public static final ReviewStatus ACKNOWLEDGED
      A reviewer acknowledged the report without an approve/reject verdict.

    • CHANGES_REQUESTED

      public static final ReviewStatus CHANGES_REQUESTED
      A reviewer requested changes ("Regenerate"): the review's comments are handed back to the pipeline so a generator can course-correct and publish a new review. A terminal decision like the others.

    • EXPIRED

      public static final ReviewStatus EXPIRED
      A blocking review's SLA elapsed with no decision; the pipeline received a timeout.

    • ABORTED

      public static final ReviewStatus ABORTED
      The owning build was aborted/stopped while a blocking review was still open.

  • Method Details

    • values

      public static ReviewStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ReviewStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isDecided

      public boolean isDecided()
      Returns:
      true once a decision (or expiry) has been recorded; no further transitions.

    • allowsEdit

      public boolean allowsEdit()
      Returns:
      true while the durable review copy may still be edited (versioned). Editing is allowed while OPEN and, deliberately, while CHANGES_REQUESTED: that state exists precisely so a generator (e.g. the regenerate-agent) can course-correct the document in place and record the new version — every other terminal decision is final and read-only.