i_rule_data

Module for IRuleData interface

!!! interfaces IRuleData

IRuleData (ABC)

Interface for rules data information

Source code in api/i_rule_data.py

class IRuleData(ABC):
    """Interface for rules data information"""

    @property
    @abstractmethod
    def name(self) -> str:
        """Name of the rule"""

    @property
    @abstractmethod
    def description(self) -> str:
        """Description of the rule"""

    @property
    @abstractmethod
    def output_variable(self) -> str:
        """Read the rule using the name"""

description: str property readonly

Description of the rule

name: str property readonly

Name of the rule

output_variable: str property readonly

Read the rule using the name