Package com.polarion.alm.tracker.workflow

Interface IContributionsManager

public interface IContributionsManager
This interface serves for discovery of existing workflow conditions, functions and validators and for instantiations of these.

It can be used by clients, who need to know, which conditions/functions/validators are available (e.g. workflow editor).

Author:
dobisekm

  • Method Details

    • isConditionDefined

      boolean isConditionDefined(@NotNull String prototype, @NotNull String name)
      Determines if a condition with the specified name exists
      Parameters:
      name -
      Returns:
      true if the given condition exists, false otherwise. true is returned also for the hidden conditions which are not listed by getConditions().
      Since:
      3.8.1

    • isFunctionDefined

      boolean isFunctionDefined(@NotNull String prototype, @NotNull String name)
      Parameters:
      name -
      Returns:
      true if the given function exists, false otherwise. true is returned also for the hidden functions which are not listed by getFunctions().
      Since:
      3.8.1

    • isValidatorDefined

      boolean isValidatorDefined(@NotNull String prototype, @NotNull String name)
      Parameters:
      name -
      Returns:
      true if the given validator exists, false otherwise. true is returned also for the hidden validators which are not listed by getValidators().
      Since:
      3.8.1

    • isSignaturePolicyDefined

      boolean isSignaturePolicyDefined(@NotNull String prototype, @NotNull String name)
      Determines if a signature policy with the specified name exists.
      Parameters:
      name -
      Returns:
      true if the given policy exists, false otherwise.
      Since:
      3.9.0

    • getConditions

      @NotNull Map<String,IContribution> getConditions(@NotNull String prototype)
      Returns:
      The map Name -> IContribution describing existing user-visible conditions. Note, that the hidden conditions are not listed in the map.
      Since:
      3.8.1
      See Also:

    • getFunctions

      @NotNull Map<String,IContribution> getFunctions(@NotNull String prototype)
      Returns:
      The map Name -> IContribution describing existing user-visible functions. Note, that the hidden functions are not listed in the map.
      Since:
      3.8.1
      See Also:

    • getValidators

      @NotNull Map<String,IContribution> getValidators(@NotNull String prototype)
      Returns:
      The map Name -> IContribution describing existing user-visible validators. Note, that the hidden validators are not listed in the map.
      Since:
      3.8.1
      See Also:

    • getSignaturePolicies

      @NotNull Map<String,IContribution> getSignaturePolicies(@NotNull String prototype)
      Returns:
      The map Id -> IContribution describing existing signature policies.
      Since:
      3.9.0

    • isNotRecognizedCondition

      boolean isNotRecognizedCondition(@NotNull String prototype, @NotNull String name)
      Determines if a condition with the specified name is stored as NotRecognizedCondition
      Parameters:
      name -
      Returns:
      true if the given condition is stored as NotRecognizedCondition, false otherwise.
      Since:
      3.8.1

    • isNotRecognizedFunction

      boolean isNotRecognizedFunction(@NotNull String prototype, @NotNull String name)
      Determines if a function with the specified name is stored as NotRecognizedFunction
      Parameters:
      name -
      Returns:
      true if the given condition is stored as NotRecognizedFunction, false otherwise.
      Since:
      3.8.1

    • isNotRecognizedSignaturePolicy

      boolean isNotRecognizedSignaturePolicy(@NotNull String prototype, @NotNull String name)
      Determines if a signature policy with the specified name is registered as not recognized signature policy.
      Since:
      3.9.0

    • createObject

      @NotNull Object createObject(@NotNull String prototype, @Nullable String contributionName) throws ClassNotFoundException, InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException
      Instantiates the object with given name. WARNING: This method is for internal use only.
      Throws:
      ClassNotFoundException
      InstantiationException
      IllegalAccessException
      IllegalArgumentException
      InvocationTargetException
      NoSuchMethodException
      SecurityException

    • addConditions

      void addConditions(@NotNull Map<String,com.polarion.alm.tracker.internal.workflow.ContributionHolder> conditions)
      Add new conditions. WARNING: This method is for internal use only.
      Since:
      3.6.1

    • addFunctions

      void addFunctions(@NotNull Map<String,com.polarion.alm.tracker.internal.workflow.ContributionHolder> functions)
      Add new functions. WARNING: This method is for internal use only.
      Since:
      3.6.1

    • addSignaturePolicies

      void addSignaturePolicies(@NotNull Map<String,com.polarion.alm.tracker.internal.workflow.ContributionHolder> signaturePolicies)
      Add new signature policies. WARNING: This method is for internal use only.
      Since:
      3.9.0

    • isConditionDefined

      @Deprecated boolean isConditionDefined(@NotNull String name)
      Deprecated.
      Shortcut for isConditionDefined(IWorkItem.PROTO, name).
      Parameters:
      name -

    • isFunctionDefined

      @Deprecated boolean isFunctionDefined(@NotNull String name)
      Deprecated.
      Shortcut for isFunctionDefined(IWorkItem.PROTO, name).
      Parameters:
      name -

    • isValidatorDefined

      @Deprecated boolean isValidatorDefined(@NotNull String name)
      Deprecated.
      Shortcut for isValidatorDefined(IWorkItem.PROTO, name).
      Parameters:
      name -

    • isNotRecognizedCondition

      @Deprecated boolean isNotRecognizedCondition(@NotNull String name)
      Deprecated.
      Shortcut for isNotRecognizedCondition(IWorkItem.PROTO, name).
      Since:
      3.6.1

    • isNotRecognizedFunction

      @Deprecated boolean isNotRecognizedFunction(@NotNull String name)
      Deprecated.
      Shortcut for isNotRecognizedFunction(IWorkItem.PROTO, name).
      Since:
      3.6.1

    • getConditions

      @Deprecated @NotNull Map getConditions()
      Deprecated.
      Shortcut for getConditions(IWorkItem.PROTO).

    • getFunctions

      @Deprecated @NotNull Map<String,IContribution> getFunctions()
      Deprecated.
      Shortcut for getFunctions(IWorkItem.PROTO).

    • getValidators

      @Deprecated @NotNull Map<String,IContribution> getValidators()
      Deprecated.
      Shortcut for getValidators(IWorkItem.PROTO).