org.broadleafcommerce.openadmin.dto

Class Entity

java.lang.Object

org.broadleafcommerce.openadmin.dto.Entity

All Implemented Interfaces:

java.io.Serializable

public class Entity
extends java.lang.Object
implements java.io.Serializable

Generic DTO for a domain object. Each property of the domain object is represented by the 'properties' instance variable which allows for further display metadata to be stored.

Author:

jfischer

See Also:

Property}, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	isActive
protected java.lang.Boolean	isDeleted
protected boolean	isDirty
protected java.lang.Boolean	isInactive
protected java.lang.Boolean	isLocked
protected boolean	isValidationFailure
protected java.lang.String	lockedBy
protected java.lang.String	lockedDate
protected boolean	multiPartAvailableOnThread
protected java.util.Map<java.lang.String,Property>	pMap
protected Property[]	properties
protected static long	serialVersionUID
protected java.lang.String[]	type
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	validationErrors

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property property)
void	addValidationError(java.lang.String fieldName, java.lang.String errorOrErrorKey) Adds a single validation error to this entity.
boolean	equals(java.lang.Object o)
Property	findProperty(java.lang.String name)
java.lang.Boolean	getActive()
java.lang.Boolean	getDeleted()
java.lang.Boolean	getInactive()
java.lang.Boolean	getLocked()
java.lang.String	getLockedBy()
java.lang.String	getLockedDate()
java.util.Map<java.lang.String,Property>	getPMap()
Property[]	getProperties()
java.lang.String[]	getType()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getValidationErrors() Validation error map where the key corresponds to the property that failed validation (which could be dot-separated) and the value corresponds to a list of the error messages, in the case of multiple errors on the same field.
int	hashCode()
boolean	isDirty()
boolean	isMultiPartAvailableOnThread()
boolean	isValidationFailure()
void	mergeProperties(java.lang.String prefix, Entity entity)
void	overridePropertyValues(Entity entity) Replaces all property values in this entity with the values from the given entity.
void	setActive(java.lang.Boolean active)
void	setDeleted(java.lang.Boolean deleted)
void	setDirty(boolean dirty)
void	setInactive(java.lang.Boolean inactive)
void	setLocked(java.lang.Boolean locked)
void	setLockedBy(java.lang.String lockedBy)
void	setLockedDate(java.lang.String lockedDate)
void	setMultiPartAvailableOnThread(boolean multiPartAvailableOnThread)
void	setProperties(Property[] properties)
void	setType(java.lang.String[] type)
void	setValidationErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> validationErrors) Completely reset the validation errors for this Entity.
void	setValidationFailure(boolean validationFailure)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

type

protected java.lang.String[] type

properties

protected Property[] properties

isDirty

protected boolean isDirty

isDeleted

protected java.lang.Boolean isDeleted

isInactive

protected java.lang.Boolean isInactive

isActive

protected java.lang.Boolean isActive

isLocked

protected java.lang.Boolean isLocked

lockedBy

protected java.lang.String lockedBy

lockedDate

protected java.lang.String lockedDate

multiPartAvailableOnThread

protected boolean multiPartAvailableOnThread

isValidationFailure

protected boolean isValidationFailure

validationErrors

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> validationErrors

pMap

protected java.util.Map<java.lang.String,Property> pMap

Constructor Detail

Entity

public Entity()

Method Detail

getType

public java.lang.String[] getType()

setType

public void setType(java.lang.String[] type)

getPMap

public java.util.Map<java.lang.String,Property> getPMap()

getProperties

public Property[] getProperties()

setProperties

public void setProperties(Property[] properties)

mergeProperties

public void mergeProperties(java.lang.String prefix,
                            Entity entity)

overridePropertyValues

public void overridePropertyValues(Entity entity)

Replaces all property values in this entity with the values from the given entity. This also resets the pMap

Parameters:

entity -

findProperty

public Property findProperty(java.lang.String name)

addProperty

public void addProperty(Property property)

addValidationError

public void addValidationError(java.lang.String fieldName,
                               java.lang.String errorOrErrorKey)

Adds a single validation error to this entity. This will also set the entire entity in an error state by invoking setValidationFailure(boolean).

Parameters:

fieldName - - the field that is in error. This works on top-level properties (like a 'manufacturer' field on a Product entity) but can also work on properties gleaned from a related entity (like 'defaultSku.weight.weightUnitOfMeasure' on a Product entity)

errorOrErrorKey - - the error message to present to a user. Could be the actual error message or a key to a property in messages.properties to support different locales

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean dirty)

isMultiPartAvailableOnThread

public boolean isMultiPartAvailableOnThread()

setMultiPartAvailableOnThread

public void setMultiPartAvailableOnThread(boolean multiPartAvailableOnThread)

isValidationFailure

public boolean isValidationFailure()

setValidationFailure

public void setValidationFailure(boolean validationFailure)

getValidationErrors

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getValidationErrors()

Validation error map where the key corresponds to the property that failed validation (which could be dot-separated) and the value corresponds to a list of the error messages, in the case of multiple errors on the same field. For instance, you might have a configuration where the field is both a Required validator and a regex validator. The validation map in this case might contain something like: defaultSku.name => ['This field is required', 'Cannot have numbers in name']

Returns:

a map keyed by property name to the list of error messages for that property

setValidationErrors

public void setValidationErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> validationErrors)

Completely reset the validation errors for this Entity. In most cases it is more appropriate to use the convenience method for adding a single error via addValidationError(String, String). This will also set the entire entity in an error state by invoking setValidationFailure(boolean).

Parameters:

validationErrors -

See Also:

addValidationError(String, String)

getActive

public java.lang.Boolean getActive()

setActive

public void setActive(java.lang.Boolean active)

getDeleted

public java.lang.Boolean getDeleted()

setDeleted

public void setDeleted(java.lang.Boolean deleted)

getInactive

public java.lang.Boolean getInactive()

setInactive

public void setInactive(java.lang.Boolean inactive)

getLocked

public java.lang.Boolean getLocked()

setLocked

public void setLocked(java.lang.Boolean locked)

getLockedBy

public java.lang.String getLockedBy()

setLockedBy

public void setLockedBy(java.lang.String lockedBy)

getLockedDate

public java.lang.String getLockedDate()

setLockedDate

public void setLockedDate(java.lang.String lockedDate)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object