Package com.polarion.alm.tracker.model.signatures

Interface IWorkflowSignature

All Superinterfaces:
IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject, IUniqueObject
All Known Subinterfaces:
IDocumentWorkflowSignature, ITestRunWorkflowSignature, IWorkItemWorkflowSignature
public interface IWorkflowSignature extends IUniqueObject
Workflow signature represents signature for one transition to a workflow status of the parent object. If there are multiple transitions to the same workflow status in the history of the parent object, each is represented by separate workflow signature. Workflow signature is called closed if the transition to the target workflow status was already performed or the workflow signature was marked as obsolete. Workflow signatures for already performed transitions are locked for changes (except for marking as obsolete).
Since:
3.9.0
See Also:

  • Field Details

  • Method Details

    • getWorkflowObject

      @NotNull IWorkflowObject getWorkflowObject()
      The workflow object to which this workflow signature belongs.

    • getTargetStatus

      @Nullable IStatusOpt getTargetStatus()
      The target workflow status of the parent workflow object, transition to which is signed by this object.

    • getTransitionRevision

      @Nullable String getTransitionRevision()
      Revision of the parent object in which the workflow transition was performed, or null if the transition was not performed yet.

    • isClosed

      boolean isClosed()

    • getSignatures

      @NotNull List<ISignature> getSignatures()
      Returns all signatures. Returned list is live, so changes to it are reflected in the workflow signature.

    • addSignature

      @NotNull ISignature addSignature(@NotNull IUser signer)
      Adds an invited signature if signature for the user does not exist yet. This method should be used also for setting of the signature status - first use this method to get the signature and then set the signature status on it.
      Returns:
      added or found signature

    • getSignature

      @Nullable ISignature getSignature(@NotNull IUser signer)
      Returns existing signature of the user, or null.

    • removeSignature

      void removeSignature(@NotNull IUser signer)
      Removes signature of the user, has no effect if there is no such signature.

    • resetSignatures

      void resetSignatures()
      Resets all existing signatures to invited status.

    • getSignatureState

      @NotNull ISignatureStateOpt getSignatureState()
      Returns the current signature state, calculates the current state if necessary.

    • setObsolete

      void setObsolete(boolean obsolete)
      Marks or unmarks this workflow signature as obsolete. If obsolete is true, the workflow signature state is changed to ISignatureStateOpt.OPT_OBSOLETE and related verdict comments are resolved. If obsolete is false and the current signature state is ISignatureStateOpt.OPT_OBSOLETE, the signature state is cleared and recalculated.

    • getLabel

      @NotNull String getLabel()
      Returns the workflow signature label.