Interface ISignatureData

All Superinterfaces:
IChangeGenerator, IChangeListener, IHasCustomValues, IHasValues, IStructure

public interface ISignatureData extends IStructure
Signature related data of a comment.
Since:
3.9.0
See Also:
  • Field Details

  • Method Details

    • getTargetStatus

      @Nullable IStatusOpt getTargetStatus()
      Returns the target workflow status of the comment's parent object, i.e. the workflow status in context of which the comment was added.
    • getWorkflowActionId

      @Nullable String getWorkflowActionId()
      Returns the workflow action ID of the corresponding workflow action.
    • getWorkflowActionLabel

      @Nullable String getWorkflowActionLabel()
      Returns the workflow action name to display.
    • setVerdictData

      void setVerdictData(@NotNull String verdict, @Nullable String signerRole)
      Sets verdict signature data.
      Parameters:
      verdict - signature verdict id (ISignatureVerdictOpt.OPT_SIGNED or ISignatureVerdictOpt.OPT_DECLINED)
      signerRole - the signer role or null
    • getVerdict

      @Nullable ISignatureVerdictOpt getVerdict()
      If the corresponding comment is a verdict comment, returns the signature verdict - signed or declined. Returns null if the parent comment is not a verdict comment. A verdict comment is a comment which was added when setting signed or declined verdict of the comment's parent object.
      See Also:
    • getSignerRole

      @Nullable String getSignerRole()
      If the corresponding comment is a verdict comment, returns the signer role of the author of that comment. A verdict comment is a comment which was added when setting signed or declined verdict of the comment's parent object.
    • getWorkflowSignature

      @Nullable IWorkflowSignature getWorkflowSignature()
      Workflow signature for which this comment was created.