The Rule Interface

Docs

Search

Help & Feedback

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Topic

Author:

Fluent Commerce

Changed on:

13 Nov 2023

Overview

The Rule Interface defines a class as a Workflow Framework compatible executable Rule.

The Rule

The Rule interface declares a `run` method that takes in single runtime parameter of type `Context`.

The `Context` contains everything the Rule instance needs to execute its logic.

Here are the main things you will find available on the `Context` parameter for use within the Rule:

The Orchestrateable Entity - e.g: `context.getEntity()`
The API Client - e.g: `context.api()`
The Source Event - e.g: `context.getEvent()`
The Rule Parameters - e.g: `context.getProp()`

The `Context` also provides the ability to output an action from the Rule. This is done via `context.action().<ActionName>`.

Fluent Commerce

Copyright © 2024-2025 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.