Package org.broadleafcommerce.openadmin.server.service.sandbox

Class SandBoxNameValidator

java.lang.Object

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

org.broadleafcommerce.openadmin.server.service.sandbox.SandBoxNameValidator

All Implemented Interfaces:

PropertyValidator

@Component("blSandBoxNameValidator")
public class SandBoxNameValidator
extends ValidationConfigurationBasedPropertyValidator

Ensures that the SandBox name is unique within a given site.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field	Description
protected String	ERROR_DUPLICATE_SANDBOX_NAME
protected org.broadleafcommerce.common.sandbox.service.SandBoxService	sandboxService
protected boolean	succeedForNullValues	Denotes what should occur when this validator encounters a null value to validate against.

Constructor Summary

Constructors

Constructor	Description
SandBoxNameValidator()

Method Summary

Modifier and Type	Method	Description
boolean	isSucceedForNullValues()
void	setSucceedForNullValues(boolean succeedForNullValues)
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

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.validation.ValidationConfigurationBasedPropertyValidator

validateInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sandboxService

protected org.broadleafcommerce.common.sandbox.service.SandBoxService sandboxService

succeedForNullValues

protected boolean succeedForNullValues

Denotes what should occur when this validator encounters a null value to validate against. Default behavior is to allow them, which means that this validator will always return true with null values

ERROR_DUPLICATE_SANDBOX_NAME

protected String ERROR_DUPLICATE_SANDBOX_NAME

Constructor Details

SandBoxNameValidator

public SandBoxNameValidator()

Method Details

validate

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

Description copied from interface: PropertyValidator

Validates a property for an entity

Specified by:

validate in interface PropertyValidator

Overrides:

validate in class ValidationConfigurationBasedPropertyValidator

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.

isSucceedForNullValues

public boolean isSucceedForNullValues()

setSucceedForNullValues

public void setSucceedForNullValues(boolean succeedForNullValues)