Package de.hybris.platform.validation.model.constraints

Class AbstractConstraintModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.validation.model.constraints.AbstractConstraintModel
All Implemented Interfaces:
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:

  • Nested Class Summary

    Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

  • Field Summary

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

    Fields inherited from class de.hybris.platform.core.model.ItemModel

    _COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

    Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractConstraintModel()
    Generated constructor - Default constructor for generic creation.
    AbstractConstraintModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
    Generated constructor - Default constructor for creation with existing context
    AbstractConstraintModel(Class _annotation, 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(Class _annotation, 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

  • Method Summary

    Modifier and Type
    Method
    Description
    Class
    getAnnotation()
    Generated method - Getter of the AbstractConstraint.annotation attribute defined at extension validation.
    Set<ConstraintGroupModel>
    getConstraintGroups()
    Generated method - Getter of the AbstractConstraint.constraintGroups attribute defined at extension validation.
    String
    getDefaultMessage()
    Generated method - Getter of the AbstractConstraint.defaultMessage attribute defined at extension validation.
    String
    getDefaultMessage(Locale loc)
    Generated method - Getter of the AbstractConstraint.defaultMessage attribute defined at extension validation.
    String
    getId()
    Generated method - Getter of the AbstractConstraint.id attribute defined at extension validation.
    String
    getMessage()
    Generated method - Getter of the AbstractConstraint.message attribute defined at extension validation.
    String
    getMessage(Locale loc)
    Generated method - Getter of the AbstractConstraint.message attribute defined at extension validation.
    Severity
    getSeverity()
    Generated method - Getter of the AbstractConstraint.severity attribute defined at extension validation.
    Class
    getTarget()
    Generated method - Getter of the AbstractConstraint.target attribute defined at extension validation.
    ComposedTypeModel
    getType()
    Generated method - Getter of the AbstractConstraint.type attribute defined at extension validation.
    boolean
    isActive()
    Generated method - Getter of the AbstractConstraint.active attribute defined at extension validation.
    boolean
    isNeedReload()
    Generated method - Getter of the AbstractConstraint.needReload dynamic attribute defined at extension validation.
    void
    setActive(boolean value)
    Generated method - Setter of AbstractConstraint.active attribute defined at extension validation.
    void
    setAnnotation(Class value)
    Generated method - Setter of AbstractConstraint.annotation attribute defined at extension validation.
    void
    setConstraintGroups(Set<ConstraintGroupModel> value)
    Generated method - Setter of AbstractConstraint.constraintGroups attribute defined at extension validation.
    void
    setId(String value)
    Generated method - Setter of AbstractConstraint.id attribute defined at extension validation.
    void
    setMessage(String value)
    Generated method - Setter of AbstractConstraint.message attribute defined at extension validation.
    void
    setMessage(String value, Locale loc)
    Generated method - Setter of AbstractConstraint.message attribute defined at extension validation.
    void
    setSeverity(Severity value)
    Generated method - Setter of AbstractConstraint.severity attribute defined at extension validation.
    void
    setTarget(Class value)
    Generated method - Setter of AbstractConstraint.target attribute defined at extension validation.
    void
    setType(ComposedTypeModel value)
    Generated method - Setter of AbstractConstraint.type attribute defined at extension validation.

    Methods inherited from class de.hybris.platform.core.model.ItemModel

    getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

    Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • ID

      public static final String ID
      Generated constant - Attribute key of AbstractConstraint.id attribute defined at extension validation.
      See Also:

    • ACTIVE

      public static final String ACTIVE
      Generated constant - Attribute key of AbstractConstraint.active attribute defined at extension validation.
      See Also:

    • NEEDRELOAD

      public static final String NEEDRELOAD
      Generated constant - Attribute key of AbstractConstraint.needReload attribute defined at extension validation.
      See Also:

    • ANNOTATION

      public static final String ANNOTATION
      Generated constant - Attribute key of AbstractConstraint.annotation attribute defined at extension validation.
      See Also:

    • SEVERITY

      public static final String SEVERITY
      Generated constant - Attribute key of AbstractConstraint.severity attribute defined at extension validation.
      See Also:

    • DEFAULTMESSAGE

      public static final String DEFAULTMESSAGE
      Generated constant - Attribute key of AbstractConstraint.defaultMessage attribute defined at extension validation.
      See Also:

    • MESSAGE

      public static final String MESSAGE
      Generated constant - Attribute key of AbstractConstraint.message attribute defined at extension validation.
      See Also:

    • TARGET

      public static final String TARGET
      Generated constant - Attribute key of AbstractConstraint.target attribute defined at extension validation.
      See Also:

    • TYPE

      public static final String TYPE
      Generated constant - Attribute key of AbstractConstraint.type attribute defined at extension validation.
      See Also:

    • CONSTRAINTGROUPS

      public static final String CONSTRAINTGROUPS
      Generated constant - Attribute key of AbstractConstraint.constraintGroups attribute defined at extension validation.
      See Also:

  • Constructor Details

    • AbstractConstraintModel

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

    • AbstractConstraintModel

      public AbstractConstraintModel(de.hybris.platform.servicelayer.model.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(Class _annotation, 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(Class _annotation, 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 Details

    • getAnnotation

      @Accessor(qualifier="annotation", type=GETTER) public 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 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 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 String getDefaultMessage(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:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • getId

      @Accessor(qualifier="id", type=GETTER) public 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 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 String getMessage(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:
      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 Class getTarget()
      Generated method - Getter of the AbstractConstraint.target attribute defined at extension validation.
      Returns:
      the target - Target class for covered with validation logic

    • getType

      @Accessor(qualifier="type", type=GETTER) public ComposedTypeModel getType()
      Generated method - Getter of the AbstractConstraint.type attribute defined at extension validation.
      Returns:
      the type

    • 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(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(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(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(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(String value, 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:
      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(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