Class AbstractRuleTemplateModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    SourceRuleTemplateModel

    public class AbstractRuleTemplateModel
    extends ItemModel
    Generated model class for type AbstractRuleTemplate first defined at extension ruleengineservices.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _RULEGROUP2ABSTRACTRULETEMPLATE
      Generated relation code constant for relation RuleGroup2AbstractRuleTemplate defining source attribute ruleGroup in extension ruleengineservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CODE
      Generated constant - Attribute key of AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
      static java.lang.String MAXALLOWEDRUNS
      Generated constant - Attribute key of AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
      static java.lang.String MESSAGEFIRED
      Generated constant - Attribute key of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
      static java.lang.String NAME
      Generated constant - Attribute key of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
      static java.lang.String RULEGROUP
      Generated constant - Attribute key of AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractRuleTemplateModel()
      Generated constructor - Default constructor for generic creation.
      AbstractRuleTemplateModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      AbstractRuleTemplateModel​(java.lang.String _code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      AbstractRuleTemplateModel​(java.lang.String _code, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()
      Generated method - Getter of the AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
      java.lang.String getDescription()
      Generated method - Getter of the AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
      java.lang.String getDescription​(java.util.Locale loc)
      Generated method - Getter of the AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
      java.lang.Integer getMaxAllowedRuns()
      Generated method - Getter of the AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
      java.lang.String getMessageFired()
      Generated method - Getter of the AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
      java.lang.String getMessageFired​(java.util.Locale loc)
      Generated method - Getter of the AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
      java.lang.String getName()
      Generated method - Getter of the AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
      RuleGroupModel getRuleGroup()
      Generated method - Getter of the AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
      void setCode​(java.lang.String value)
      Generated method - Setter of AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
      void setDescription​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
      void setMaxAllowedRuns​(java.lang.Integer value)
      Generated method - Setter of AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
      void setMessageFired​(java.lang.String value)
      Generated method - Setter of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
      void setMessageFired​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
      void setName​(java.lang.String value)
      Generated method - Setter of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
      void setRuleGroup​(RuleGroupModel value)
      Generated method - Setter of AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _RULEGROUP2ABSTRACTRULETEMPLATE

        public static final java.lang.String _RULEGROUP2ABSTRACTRULETEMPLATE
        Generated relation code constant for relation RuleGroup2AbstractRuleTemplate defining source attribute ruleGroup in extension ruleengineservices.
        See Also:
        Constant Field Values
      • CODE

        public static final java.lang.String CODE
        Generated constant - Attribute key of AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • MAXALLOWEDRUNS

        public static final java.lang.String MAXALLOWEDRUNS
        Generated constant - Attribute key of AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • MESSAGEFIRED

        public static final java.lang.String MESSAGEFIRED
        Generated constant - Attribute key of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • RULEGROUP

        public static final java.lang.String RULEGROUP
        Generated constant - Attribute key of AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractRuleTemplateModel

        public AbstractRuleTemplateModel()
        Generated constructor - Default constructor for generic creation.
      • AbstractRuleTemplateModel

        public AbstractRuleTemplateModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • AbstractRuleTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AbstractRuleTemplateModel​(java.lang.String _code)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _code - initial attribute declared by type AbstractRuleTemplate at extension ruleengineservices
      • AbstractRuleTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AbstractRuleTemplateModel​(java.lang.String _code,
                                         ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _code - initial attribute declared by type AbstractRuleTemplate at extension ruleengineservices
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getCode

        @Accessor(qualifier="code",
                  type=GETTER)
        public java.lang.String getCode()
        Generated method - Getter of the AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
        Returns:
        the code - Rule code that defines the rule uniquely
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
        Returns:
        the description - Rule description
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
        Parameters:
        loc - the value localization key
        Returns:
        the description - Rule description
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getMaxAllowedRuns

        @Accessor(qualifier="maxAllowedRuns",
                  type=GETTER)
        public java.lang.Integer getMaxAllowedRuns()
        Generated method - Getter of the AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
        Returns:
        the maxAllowedRuns - Number of times rule can be applied
      • getMessageFired

        @Accessor(qualifier="messageFired",
                  type=GETTER)
        public java.lang.String getMessageFired()
        Generated method - Getter of the AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
        Returns:
        the messageFired - Message for fired rule.
      • getMessageFired

        @Accessor(qualifier="messageFired",
                  type=GETTER)
        public java.lang.String getMessageFired​(java.util.Locale loc)
        Generated method - Getter of the AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
        Parameters:
        loc - the value localization key
        Returns:
        the messageFired - Message for fired rule.
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
        Returns:
        the name - Rule name
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
        Parameters:
        loc - the value localization key
        Returns:
        the name - Rule name
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getRuleGroup

        @Accessor(qualifier="ruleGroup",
                  type=GETTER)
        public RuleGroupModel getRuleGroup()
        Generated method - Getter of the AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
        Returns:
        the ruleGroup
      • setCode

        @Accessor(qualifier="code",
                  type=SETTER)
        public void setCode​(java.lang.String value)
        Generated method - Setter of AbstractRuleTemplate.code attribute defined at extension ruleengineservices.
        Parameters:
        value - the code - Rule code that defines the rule uniquely
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
        Parameters:
        value - the description - Rule description
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value,
                                   java.util.Locale loc)
        Generated method - Setter of AbstractRuleTemplate.description attribute defined at extension ruleengineservices.
        Parameters:
        value - the description - Rule description
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setMaxAllowedRuns

        @Accessor(qualifier="maxAllowedRuns",
                  type=SETTER)
        public void setMaxAllowedRuns​(java.lang.Integer value)
        Generated method - Setter of AbstractRuleTemplate.maxAllowedRuns attribute defined at extension ruleengineservices.
        Parameters:
        value - the maxAllowedRuns - Number of times rule can be applied
      • setMessageFired

        @Accessor(qualifier="messageFired",
                  type=SETTER)
        public void setMessageFired​(java.lang.String value)
        Generated method - Setter of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
        Parameters:
        value - the messageFired - Message for fired rule.
      • setMessageFired

        @Accessor(qualifier="messageFired",
                  type=SETTER)
        public void setMessageFired​(java.lang.String value,
                                    java.util.Locale loc)
        Generated method - Setter of AbstractRuleTemplate.messageFired attribute defined at extension ruleengineservices.
        Parameters:
        value - the messageFired - Message for fired rule.
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Setter of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
        Parameters:
        value - the name - Rule name
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value,
                            java.util.Locale loc)
        Generated method - Setter of AbstractRuleTemplate.name attribute defined at extension ruleengineservices.
        Parameters:
        value - the name - Rule name
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setRuleGroup

        @Accessor(qualifier="ruleGroup",
                  type=SETTER)
        public void setRuleGroup​(RuleGroupModel value)
        Generated method - Setter of AbstractRuleTemplate.ruleGroup attribute defined at extension ruleengineservices.
        Parameters:
        value - the ruleGroup