Class RuleActionDefinitionParameterModel

  • All Implemented Interfaces:
    java.io.Serializable

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

      Fields 
      Modifier and Type Field Description
      static java.lang.String _RULEACTIONDEFINITION2PARAMETERSRELATION
      Generated relation code constant for relation RuleActionDefinition2ParametersRelation defining source attribute definition in extension ruleengineservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String DEFAULTEDITOR
      Generated constant - Attribute key of RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
      static java.lang.String DEFINITION
      Generated constant - Attribute key of RuleActionDefinitionParameter.definition attribute defined at extension ruleengineservices.
      static java.lang.String DEFINITIONPOS
      Generated constant - Attribute key of RuleActionDefinitionParameter.definitionPOS attribute defined at extension ruleengineservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of RuleActionDefinitionParameter.description attribute defined at extension ruleengineservices.
      static java.lang.String FILTERS
      Generated constant - Attribute key of RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
      static java.lang.String ID
      Generated constant - Attribute key of RuleActionDefinitionParameter.id attribute defined at extension ruleengineservices.
      static java.lang.String NAME
      Generated constant - Attribute key of RuleActionDefinitionParameter.name attribute defined at extension ruleengineservices.
      static java.lang.String PRIORITY
      Generated constant - Attribute key of RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
      static java.lang.String REQUIRED
      Generated constant - Attribute key of RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
      static java.lang.String TYPE
      Generated constant - Attribute key of RuleActionDefinitionParameter.type attribute defined at extension ruleengineservices.
      static java.lang.String VALIDATORS
      Generated constant - Attribute key of RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices.
      static java.lang.String VALUE
      Generated constant - Attribute key of RuleActionDefinitionParameter.value attribute defined at extension ruleengineservices.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultEditor()
      Generated method - Getter of the RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
      RuleActionDefinitionModel getDefinition()
      Generated method - Getter of the RuleActionDefinitionParameter.definition attribute defined at extension ruleengineservices.
      java.lang.String getDescription()
      Generated method - Getter of the RuleActionDefinitionParameter.description attribute defined at extension ruleengineservices.
      java.lang.String getDescription​(java.util.Locale loc)
      Generated method - Getter of the RuleActionDefinitionParameter.description attribute defined at extension ruleengineservices.
      java.util.Map<java.lang.String,​java.lang.String> getFilters()
      Generated method - Getter of the RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
      java.lang.String getId()
      Generated method - Getter of the RuleActionDefinitionParameter.id attribute defined at extension ruleengineservices.
      java.lang.String getName()
      Generated method - Getter of the RuleActionDefinitionParameter.name attribute defined at extension ruleengineservices.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the RuleActionDefinitionParameter.name attribute defined at extension ruleengineservices.
      java.lang.Integer getPriority()
      Generated method - Getter of the RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
      java.lang.Boolean getRequired()
      Generated method - Getter of the RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
      java.lang.String getType()
      Generated method - Getter of the RuleActionDefinitionParameter.type attribute defined at extension ruleengineservices.
      java.util.List<java.lang.String> getValidators()
      Generated method - Getter of the RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices.
      java.lang.String getValue()
      Generated method - Getter of the RuleActionDefinitionParameter.value attribute defined at extension ruleengineservices.
      void setDefaultEditor​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
      void setDefinition​(RuleActionDefinitionModel value)
      Generated method - Setter of RuleActionDefinitionParameter.definition attribute defined at extension ruleengineservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.description attribute defined at extension ruleengineservices.
      void setDescription​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of RuleActionDefinitionParameter.description attribute defined at extension ruleengineservices.
      void setFilters​(java.util.Map<java.lang.String,​java.lang.String> value)
      Generated method - Setter of RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
      void setId​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.id attribute defined at extension ruleengineservices.
      void setName​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.name attribute defined at extension ruleengineservices.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of RuleActionDefinitionParameter.name attribute defined at extension ruleengineservices.
      void setPriority​(java.lang.Integer value)
      Generated method - Setter of RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
      void setRequired​(java.lang.Boolean value)
      Generated method - Setter of RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
      void setType​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.type attribute defined at extension ruleengineservices.
      void setValidators​(java.util.List<java.lang.String> value)
      Generated method - Setter of RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices.
      void setValue​(java.lang.String value)
      Generated method - Setter of RuleActionDefinitionParameter.value 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
      • _RULEACTIONDEFINITION2PARAMETERSRELATION

        public static final java.lang.String _RULEACTIONDEFINITION2PARAMETERSRELATION
        Generated relation code constant for relation RuleActionDefinition2ParametersRelation defining source attribute definition in extension ruleengineservices.
        See Also:
        Constant Field Values
      • ID

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

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

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

        public static final java.lang.String PRIORITY
        Generated constant - Attribute key of RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • TYPE

        public static final java.lang.String TYPE
        Generated constant - Attribute key of RuleActionDefinitionParameter.type attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • VALUE

        public static final java.lang.String VALUE
        Generated constant - Attribute key of RuleActionDefinitionParameter.value attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • REQUIRED

        public static final java.lang.String REQUIRED
        Generated constant - Attribute key of RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • VALIDATORS

        public static final java.lang.String VALIDATORS
        Generated constant - Attribute key of RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • FILTERS

        public static final java.lang.String FILTERS
        Generated constant - Attribute key of RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • DEFAULTEDITOR

        public static final java.lang.String DEFAULTEDITOR
        Generated constant - Attribute key of RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • DEFINITIONPOS

        public static final java.lang.String DEFINITIONPOS
        Generated constant - Attribute key of RuleActionDefinitionParameter.definitionPOS attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values
      • DEFINITION

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

      • RuleActionDefinitionParameterModel

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

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

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public RuleActionDefinitionParameterModel​(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:
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getDefaultEditor

        @Accessor(qualifier="defaultEditor",
                  type=GETTER)
        public java.lang.String getDefaultEditor()
        Generated method - Getter of the RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
        Returns:
        the defaultEditor - default editor for the parameter
      • getDescription

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

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

        @Accessor(qualifier="filters",
                  type=GETTER)
        public java.util.Map<java.lang.String,​java.lang.String> getFilters()
        Generated method - Getter of the RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
        Returns:
        the filters - The map defines narrowing filtering rules. For every entry: key corresponds to the type field name to narrow for, value corresponds to RuleActionDefinitionParameter.id to narrow by
      • getId

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

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

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

        @Accessor(qualifier="priority",
                  type=GETTER)
        public java.lang.Integer getPriority()
        Generated method - Getter of the RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
        Returns:
        the priority
      • getRequired

        @Accessor(qualifier="required",
                  type=GETTER)
        public java.lang.Boolean getRequired()
        Generated method - Getter of the RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
        Returns:
        the required - whether the parameter is required
      • getType

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

        @Accessor(qualifier="validators",
                  type=GETTER)
        public java.util.List<java.lang.String> getValidators()
        Generated method - Getter of the RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the validators
      • getValue

        @Accessor(qualifier="value",
                  type=GETTER)
        public java.lang.String getValue()
        Generated method - Getter of the RuleActionDefinitionParameter.value attribute defined at extension ruleengineservices.
        Returns:
        the value
      • setDefaultEditor

        @Accessor(qualifier="defaultEditor",
                  type=SETTER)
        public void setDefaultEditor​(java.lang.String value)
        Generated method - Setter of RuleActionDefinitionParameter.defaultEditor attribute defined at extension ruleengineservices.
        Parameters:
        value - the defaultEditor - default editor for the parameter
      • setDefinition

        @Accessor(qualifier="definition",
                  type=SETTER)
        public void setDefinition​(RuleActionDefinitionModel value)
        Generated method - Setter of RuleActionDefinitionParameter.definition attribute defined at extension ruleengineservices.
        Parameters:
        value - the definition
      • setDescription

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

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

        @Accessor(qualifier="filters",
                  type=SETTER)
        public void setFilters​(java.util.Map<java.lang.String,​java.lang.String> value)
        Generated method - Setter of RuleActionDefinitionParameter.filters attribute defined at extension ruleengineservices.
        Parameters:
        value - the filters - The map defines narrowing filtering rules. For every entry: key corresponds to the type field name to narrow for, value corresponds to RuleActionDefinitionParameter.id to narrow by
      • setId

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

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

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

        @Accessor(qualifier="priority",
                  type=SETTER)
        public void setPriority​(java.lang.Integer value)
        Generated method - Setter of RuleActionDefinitionParameter.priority attribute defined at extension ruleengineservices.
        Parameters:
        value - the priority
      • setRequired

        @Accessor(qualifier="required",
                  type=SETTER)
        public void setRequired​(java.lang.Boolean value)
        Generated method - Setter of RuleActionDefinitionParameter.required attribute defined at extension ruleengineservices.
        Parameters:
        value - the required - whether the parameter is required
      • setType

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

        @Accessor(qualifier="validators",
                  type=SETTER)
        public void setValidators​(java.util.List<java.lang.String> value)
        Generated method - Setter of RuleActionDefinitionParameter.validators attribute defined at extension ruleengineservices.
        Parameters:
        value - the validators
      • setValue

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