org.broadleafcommerce.openadmin.server.service.persistence.validation

Interface PropertyValidator

All Known Implementing Classes:

MatchesFieldValidator, RegexPropertyValidator, UriPropertyValidator, ValidationConfigurationBasedPropertyValidator

public interface PropertyValidator

Interface for performing validation on a property. If you are attempting to write a validator based on the

Author:

Phillip Verheyden

See Also:

ValidationConfigurationBasedPropertyValidator}, EntityValidatorService}, GlobalPropertyValidator}

Method Summary

Methods

Modifier and Type	Method and Description
PropertyValidationResult	validate(Entity entity, Serializable instance, Map<String,FieldMetadata> entityFieldMetadata, Map<String,String> validationConfiguration, BasicFieldMetadata propertyMetadata, String propertyName, String value) Validates a property for an entity

Method Detail

validate

PropertyValidationResult validate(Entity entity,
                                Serializable instance,
                                Map<String,FieldMetadata> entityFieldMetadata,
                                Map<String,String> validationConfiguration,
                                BasicFieldMetadata propertyMetadata,
                                String propertyName,
                                String value)

Validates a property for an entity

Parameters:

entity - Entity DTO of the entity attempting to save

instance - actual object representation of entity. This can be cast to entity interfaces (like Sku or Product)

entityFieldMetadata - complete field metadata for all properties in entity

validationConfiguration - the map represented by the set of ConfigurationItem for a ValidationConfiguration on a property. This map could be null if this PropertyValidator is being invoked outside of the context of a particular property (like a global validator)

propertyMetadata - BasicFieldMetadata corresponding to the property that is being valid

propertyName - the property name of the value attempting to be saved (could be a sub-entity obtained via dot notation like 'defaultSku.name')

value - the value attempted to be saved

Returns:

true if this passes validation, false otherwise.