Package com.codebarrel.automation.api.component

Interface RuleComponent

All Known Subinterfaces:
ConditionalRuleComponent
All Known Implementing Classes:
AddCustomerActionFactory, AddWorklogActionFactory, AffectedServicesConditionFactory, ArchiveActionFactory, AssignIssueActionFactory, AutoApproveActionFactory, BranchCreatedTriggerFactory, BranchTriggerFactory, CloneIssueActionFactory, CommentActionFactory, CommitCreatedTriggerFactory, ComparatorFactory, ConditionBlockFactory, CreateIssueActionFactory, CreateServiceDeskRequestActionFactory, CreateSubtasksActionFactory, CreateVariableActionFactory, CreateVersionActionFactory, DeleteActionFactory, DeleteAttachmentsActionFactory, DeleteCommentActionFactory, DeleteIssueLinkActionFactory, EditIssueActionFactory, ElseBlockFactory, FieldChangedTriggerFactory, HasAttachmentsConditionFactory, HipChatNotificationActionFactory, IfBlockFactory, IncomingWebhookTriggerFactory, IssueAssignedTriggerFactory, IssueCommentedTriggerFactory, IssueConditionFactory, IssueEventTriggerFactory, IssueLinkCreatedTriggerFactory, IssueLinkDeletedTriggerFactory, IssueMovedTriggerFactory, IssuePropertySetTriggerFactory, IssueTransitionedTriggerFactory, JqlConditionFactory, JqlScheduledTriggerFactory, LinkIssueActionFactory, LogActionFactory, LookupIssuesActionFactory, ManageWatcherActionFactory, ManualTriggerFactory, MicrosoftTeamsNotificationActionFactory, MultipleIssueEventTriggerFactory, OutgoingEmailActionFactory, OutgoingWebhookActionFactory, PluggableRuleComponent, PublishEventActionFactory, PullRequestCreatedTriggerFactory, PullRequestDeclinedTriggerFactory, PullRequestMergedTriggerFactory, RefreshIssueActionFactory, RelatedIssuesBranchFactory, RelatedIssuesConditionFactory, ReleaseVersionActionFactory, ServiceLimitBreachedTriggerFactory, SetEntityPropertyActionFactory, SimulationActionFactory, SimulationTriggerFactory, SlackNotificationActionFactory, SlaThresholdBreachedTriggerFactory, SprintClosedTriggerFactory, SprintCreatedTriggerFactory, SprintStartedTriggerFactory, StrideNotificationActionFactory, ThirdPartyRuleComponent, TransitionIssueActionFactory, TwilioNotificationActionFactory, UnknownRuleComponent, UnreleaseVersionActionFactory, UserConditionFactory, VersionCreatedTriggerFactory, VersionReleasedTriggerFactory, VersionUnreleasedTriggerFactory, VersionUpdatedTriggerFactory, WorkLoggedTriggerFactory
public interface RuleComponent
Factory that provides 'pluggable' rule components (could be actions or conditions) that do the work of executing the main parts of an automation rule.

  • Method Details

    • getNameKey

      String getNameKey()
      Returns:
      an i18nizable key to print this component in the audit log

    • getExecutor

      ComponentExecutor getExecutor()
      The worker for an automation rule. Actually performs the operation intended by this rule component.

    • getConfigType

      Class getConfigType()
      The type class of the configuration type. This aids serialization and deserialization to allow us to use reach configuration types.

    • getValidator

      default ComponentValidator getValidator()
      Helper used to validate inputs when configuring a rule component via the UI.

    • getOptimiser

      default Optional<RuleConfigBeanOptimiser> getOptimiser()
      Optionally return an optimiser that can optimise all rule components of this type in a given rule config.

    • getCustomContextProvider

      default Optional<TemplateRendererContextProvider> getCustomContextProvider()
      Optionally return a TemplateRendererContextProvider that allows for extra

    • getConfigTransformer

      default Optional<ConfigTransform> getConfigTransformer()

    • createBulkValidator

      default Optional<BulkValidator> createBulkValidator()