Interface IAction


public interface IAction
Author:
Michal Dobisek, Polarion Software
  • Method Details

    • getId

      @NotNull String getId()
    • getName

      @NotNull String getName()
    • getRoles

      @NotNull Set<String> getRoles()
      Returns:
      Live set of String role Ids. If empty, then there are no role limitations. Otherwise only users with at least of one from the given roles can perform the action.
    • getConditions

      @NotNull Set<IOperation> getConditions()
      Returns:
      Live Set of IOperations, which should be used as conditions.
    • getFunctions

      @NotNull Set<IOperation> getFunctions()
      Returns:
      Live Set of IOperations, which should be used as functions.
    • getNotRecognizedConditionsMessages

      @NotNull List<String> getNotRecognizedConditionsMessages()
      Returns:
      List of messages for all no recognized conditions.
      Since:
      3.6.1
    • getNotRecognizedFunctionsMessages

      @NotNull List<String> getNotRecognizedFunctionsMessages()
      Returns:
      List of messages for all no recognized functions.
      Since:
      3.6.1
    • getNotRecognizedSignaturePolicyMessage

      @Nullable String getNotRecognizedSignaturePolicyMessage()
      Returns:
      Message for not recognized signature policy, null for valid policy.
      Since:
      3.9.0
    • getRequired

      @NotNull Set<String> getRequired()
      Returns:
      Live set of String field Ids, which must be filled after this action is executed.
    • getCleared

      @NotNull Set<String> getCleared()
      Returns:
      Live list of String field Ids, which will be automatically cleared during this action execution.
    • getSignaturesConfiguration

      @NotNull IActionSignaturesConfiguration getSignaturesConfiguration()
      Returns the signature related settings for this action.
      Since:
      3.9.0
    • verify

      void verify(@NotNull IContributionsManager contribs) throws VerificationException
      Verifies, whether all operations (conditions and functions) used in this operation do exist.
      Parameters:
      contribs -
      Throws:
      VerificationException - If there is some wrong operation.