Class AbstractConstraintModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    AttributeConstraintModel, TypeConstraintModel

    public class AbstractConstraintModel
    extends ItemModel
    Generated model class for type AbstractConstraint first defined at extension validation.

    Abstract constraint base definition for all constraint types.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ACTIVE
      Generated constant - Attribute key of AbstractConstraint.active attribute defined at extension validation.
      static java.lang.String ANNOTATION
      Generated constant - Attribute key of AbstractConstraint.annotation attribute defined at extension validation.
      static java.lang.String CONSTRAINTGROUPS
      Generated constant - Attribute key of AbstractConstraint.constraintGroups attribute defined at extension validation.
      static java.lang.String DEFAULTMESSAGE
      Generated constant - Attribute key of AbstractConstraint.defaultMessage attribute defined at extension validation.
      static java.lang.String ID
      Generated constant - Attribute key of AbstractConstraint.id attribute defined at extension validation.
      static java.lang.String MESSAGE
      Generated constant - Attribute key of AbstractConstraint.message attribute defined at extension validation.
      static java.lang.String NEEDRELOAD
      Generated constant - Attribute key of AbstractConstraint.needReload attribute defined at extension validation.
      static java.lang.String SEVERITY
      Generated constant - Attribute key of AbstractConstraint.severity attribute defined at extension validation.
      static java.lang.String TARGET
      Generated constant - Attribute key of AbstractConstraint.target attribute defined at extension validation.
      static java.lang.String TYPE
      Generated constant - Attribute key of AbstractConstraint.type attribute defined at extension validation.
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractConstraintModel()
      Generated constructor - Default constructor for generic creation.
      AbstractConstraintModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      AbstractConstraintModel​(java.lang.Class _annotation, java.lang.String _id)
      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
      AbstractConstraintModel​(java.lang.Class _annotation, java.lang.String _id, 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
    • Field Detail

      • _TYPECODE

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

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

        public static final java.lang.String ACTIVE
        Generated constant - Attribute key of AbstractConstraint.active attribute defined at extension validation.
        See Also:
        Constant Field Values
      • NEEDRELOAD

        public static final java.lang.String NEEDRELOAD
        Generated constant - Attribute key of AbstractConstraint.needReload attribute defined at extension validation.
        See Also:
        Constant Field Values
      • ANNOTATION

        public static final java.lang.String ANNOTATION
        Generated constant - Attribute key of AbstractConstraint.annotation attribute defined at extension validation.
        See Also:
        Constant Field Values
      • SEVERITY

        public static final java.lang.String SEVERITY
        Generated constant - Attribute key of AbstractConstraint.severity attribute defined at extension validation.
        See Also:
        Constant Field Values
      • DEFAULTMESSAGE

        public static final java.lang.String DEFAULTMESSAGE
        Generated constant - Attribute key of AbstractConstraint.defaultMessage attribute defined at extension validation.
        See Also:
        Constant Field Values
      • MESSAGE

        public static final java.lang.String MESSAGE
        Generated constant - Attribute key of AbstractConstraint.message attribute defined at extension validation.
        See Also:
        Constant Field Values
      • TARGET

        public static final java.lang.String TARGET
        Generated constant - Attribute key of AbstractConstraint.target attribute defined at extension validation.
        See Also:
        Constant Field Values
      • TYPE

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

        public static final java.lang.String CONSTRAINTGROUPS
        Generated constant - Attribute key of AbstractConstraint.constraintGroups attribute defined at extension validation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractConstraintModel

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

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

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AbstractConstraintModel​(java.lang.Class _annotation,
                                       java.lang.String _id)
        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:
        _annotation - initial attribute declared by type AbstractConstraint at extension validation
        _id - initial attribute declared by type AbstractConstraint at extension validation
      • AbstractConstraintModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AbstractConstraintModel​(java.lang.Class _annotation,
                                       java.lang.String _id,
                                       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:
        _annotation - initial attribute declared by type AbstractConstraint at extension validation
        _id - initial attribute declared by type AbstractConstraint at extension validation
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getAnnotation

        @Accessor(qualifier="annotation",
                  type=GETTER)
        public java.lang.Class getAnnotation()
        Generated method - Getter of the AbstractConstraint.annotation attribute defined at extension validation.
        Returns:
        the annotation - Full class name literal for a corresponding annotation
      • getConstraintGroups

        @Accessor(qualifier="constraintGroups",
                  type=GETTER)
        public java.util.Set<ConstraintGroupModel> getConstraintGroups()
        Generated method - Getter of the AbstractConstraint.constraintGroups attribute defined at extension validation. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the constraintGroups
      • getDefaultMessage

        @Accessor(qualifier="defaultMessage",
                  type=GETTER)
        public java.lang.String getDefaultMessage()
        Generated method - Getter of the AbstractConstraint.defaultMessage attribute defined at extension validation.
        Returns:
        the defaultMessage - Localized resource bundle evaluated error message
      • getDefaultMessage

        @Accessor(qualifier="defaultMessage",
                  type=GETTER)
        public java.lang.String getDefaultMessage​(java.util.Locale loc)
        Generated method - Getter of the AbstractConstraint.defaultMessage attribute defined at extension validation.
        Parameters:
        loc - the value localization key
        Returns:
        the defaultMessage - Localized resource bundle evaluated error message
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getId

        @Accessor(qualifier="id",
                  type=GETTER)
        public java.lang.String getId()
        Generated method - Getter of the AbstractConstraint.id attribute defined at extension validation.
        Returns:
        the id - Constraint identifier
      • getMessage

        @Accessor(qualifier="message",
                  type=GETTER)
        public java.lang.String getMessage()
        Generated method - Getter of the AbstractConstraint.message attribute defined at extension validation.
        Returns:
        the message - Localized error message
      • getMessage

        @Accessor(qualifier="message",
                  type=GETTER)
        public java.lang.String getMessage​(java.util.Locale loc)
        Generated method - Getter of the AbstractConstraint.message attribute defined at extension validation.
        Parameters:
        loc - the value localization key
        Returns:
        the message - Localized error message
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getSeverity

        @Accessor(qualifier="severity",
                  type=GETTER)
        public Severity getSeverity()
        Generated method - Getter of the AbstractConstraint.severity attribute defined at extension validation.
        Returns:
        the severity - Severity level
      • getTarget

        @Accessor(qualifier="target",
                  type=GETTER)
        public java.lang.Class getTarget()
        Generated method - Getter of the AbstractConstraint.target attribute defined at extension validation.
        Returns:
        the target - Target class for covered with validation logic
      • isActive

        @Accessor(qualifier="active",
                  type=GETTER)
        public boolean isActive()
        Generated method - Getter of the AbstractConstraint.active attribute defined at extension validation.
        Returns:
        the active - Enabled flag for a constraint
      • isNeedReload

        @Accessor(qualifier="needReload",
                  type=GETTER)
        public boolean isNeedReload()
        Generated method - Getter of the AbstractConstraint.needReload dynamic attribute defined at extension validation.
        Returns:
        the needReload - true if the constraint (+values) was never loaded (in the current state) into the framework.
      • setActive

        @Accessor(qualifier="active",
                  type=SETTER)
        public void setActive​(boolean value)
        Generated method - Setter of AbstractConstraint.active attribute defined at extension validation.
        Parameters:
        value - the active - Enabled flag for a constraint
      • setAnnotation

        @Accessor(qualifier="annotation",
                  type=SETTER)
        public void setAnnotation​(java.lang.Class value)
        Generated method - Setter of AbstractConstraint.annotation attribute defined at extension validation.
        Parameters:
        value - the annotation - Full class name literal for a corresponding annotation
      • setConstraintGroups

        @Accessor(qualifier="constraintGroups",
                  type=SETTER)
        public void setConstraintGroups​(java.util.Set<ConstraintGroupModel> value)
        Generated method - Setter of AbstractConstraint.constraintGroups attribute defined at extension validation.
        Parameters:
        value - the constraintGroups
      • setId

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

        @Accessor(qualifier="message",
                  type=SETTER)
        public void setMessage​(java.lang.String value)
        Generated method - Setter of AbstractConstraint.message attribute defined at extension validation.
        Parameters:
        value - the message - Localized error message
      • setMessage

        @Accessor(qualifier="message",
                  type=SETTER)
        public void setMessage​(java.lang.String value,
                               java.util.Locale loc)
        Generated method - Setter of AbstractConstraint.message attribute defined at extension validation.
        Parameters:
        value - the message - Localized error message
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setSeverity

        @Accessor(qualifier="severity",
                  type=SETTER)
        public void setSeverity​(Severity value)
        Generated method - Setter of AbstractConstraint.severity attribute defined at extension validation.
        Parameters:
        value - the severity - Severity level
      • setTarget

        @Accessor(qualifier="target",
                  type=SETTER)
        public void setTarget​(java.lang.Class value)
        Generated method - Setter of AbstractConstraint.target attribute defined at extension validation.
        Parameters:
        value - the target - Target class for covered with validation logic
      • setType

        @Accessor(qualifier="type",
                  type=SETTER)
        public void setType​(ComposedTypeModel value)
        Generated method - Setter of AbstractConstraint.type attribute defined at extension validation.
        Parameters:
        value - the type