Entity (BroadleafCommerce 6.2.2-SNAPSHOT API)

java.lang.Object
- org.broadleafcommerce.openadmin.dto.Entity

All Implemented Interfaces:

Serializable
```
public class Entity
extends Object
implements 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 Date`	`deployDate`
`protected List<String>`	`globalValidationErrors`
`protected Boolean`	`isActive`
`protected Boolean`	`isDeleted`
`protected boolean`	`isDirty`
`protected Boolean`	`isInactive`
`protected boolean`	`isPreAdd`
`protected boolean`	`isValidationFailure`
`protected boolean`	`multiPartAvailableOnThread`
`protected Map<String,Property>`	`pMap`
`protected Property[]`	`properties`
`protected static long`	`serialVersionUID`
`protected String[]`	`type`
`protected Map<String,List<String>>`	`validationErrors`

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGlobalValidationError(String errorOrErrorKey)` Adds a validation error to this entity that is not tied to any specific property.
`void`	`addGlobalValidationErrors(List<String> errorOrErrorKeys)` Similar to `addGlobalValidationError(String)` except with a list of errors
`void`	`addProperty(Property property)`
`void`	`addValidationError(String fieldName, String errorOrErrorKey)` Adds a single validation error to this entity.
`boolean`	`equals(Object o)`
`Property`	`findProperty(String name)`
`Boolean`	`getActive()`
`Boolean`	`getDeleted()`
`Date`	`getDeployDate()`
`List<String>`	`getGlobalValidationErrors()`
`Boolean`	`getInactive()`
`Map<String,Property>`	`getPMap()`
`Property[]`	`getProperties()`
`Map<String,List<String>>`	`getPropertyValidationErrors()` 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.
`String[]`	`getType()`
`Map<String,List<String>>`	`getValidationErrors()` Deprecated. use `getPropertyValidationErrors()` instead
`int`	`hashCode()`
`boolean`	`isDirty()`
`boolean`	`isMultiPartAvailableOnThread()`
`boolean`	`isPreAdd()`
`boolean`	`isValidationFailure()`
`void`	`mergeProperties(String prefix, Entity entity)`
`void`	`overridePropertyValues(Entity entity)` Replaces all property values in this entity with the values from the given entity.
`Property`	`removeProperty(String name)`
`void`	`setActive(Boolean active)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setDeployDate(Date deployDate)`
`void`	`setDirty(boolean dirty)`
`void`	`setGlobalValidationErrors(List<String> globalValidationErrors)`
`void`	`setInactive(Boolean inactive)`
`void`	`setIsPreAdd(boolean isPreAdd)`
`void`	`setMultiPartAvailableOnThread(boolean multiPartAvailableOnThread)`
`void`	`setProperties(Property[] properties)`
`void`	`setPropertyValidationErrors(Map<String,List<String>> validationErrors)` Completely reset the validation errors for this Entity.
`void`	`setType(String[] type)`
`void`	`setValidationErrors(Map<String,List<String>> validationErrors)` Deprecated. use `setPropertyValidationErrors(Map)` instead
`void`	`setValidationFailure(boolean validationFailure)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
protected static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - type
```
protected String[] type
```
  - properties
```
protected Property[] properties
```
  - isDirty
```
protected boolean isDirty
```
  - deployDate
```
protected Date deployDate
```
  - isDeleted
```
protected Boolean isDeleted
```
  - isInactive
```
protected Boolean isInactive
```
  - isActive
```
protected Boolean isActive
```
  - multiPartAvailableOnThread
```
protected boolean multiPartAvailableOnThread
```
  - isValidationFailure
```
protected boolean isValidationFailure
```
  - isPreAdd
```
protected boolean isPreAdd
```
  - validationErrors
```
protected Map<String,List<String>> validationErrors
```
  - globalValidationErrors
```
protected List<String> globalValidationErrors
```
  - pMap
```
protected Map<String,Property> pMap
```
- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - getType
```
public String[] getType()
```
  - setType
```
public void setType(String[] type)
```
  - getPMap
```
public Map<String,Property> getPMap()
```
  - getProperties
```
public Property[] getProperties()
```
  - setProperties
```
public void setProperties(Property[] properties)
```
  - mergeProperties
```
public void mergeProperties(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(String name)
```
  - addProperty
```
public void addProperty(Property property)
```
  - removeProperty
```
public Property removeProperty(String name)
```
  - addValidationError
```
public void addValidationError(String fieldName,
                               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()
```
    Returns:
    
    if this entity has failed validation. This will also check the getPropertyValidationErrors() map and getGlobalValidationErrors() if this boolean has not been explicitly set
  - setValidationFailure
```
public void setValidationFailure(boolean validationFailure)
```
  - isPreAdd
```
public boolean isPreAdd()
```
  - setIsPreAdd
```
public void setIsPreAdd(boolean isPreAdd)
```
  - getValidationErrors
```
@Deprecated
public Map<String,List<String>> getValidationErrors()
```
    Deprecated. use getPropertyValidationErrors() instead
    
    Returns:
  - getPropertyValidationErrors
```
public Map<String,List<String>> getPropertyValidationErrors()
```
    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
```
@Deprecated
public void setValidationErrors(Map<String,List<String>> validationErrors)
```
    Deprecated. use setPropertyValidationErrors(Map) instead
  - setPropertyValidationErrors
```
public void setPropertyValidationErrors(Map<String,List<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)
  - addGlobalValidationError
```
public void addGlobalValidationError(String errorOrErrorKey)
```
    Adds a validation error to this entity that is not tied to any specific property. If you need to tie this to a property then you should use addValidationError(String, String) instead.
    
    Parameters:
    
    errorOrErrorKey -
  - addGlobalValidationErrors
```
public void addGlobalValidationErrors(List<String> errorOrErrorKeys)
```
    Similar to addGlobalValidationError(String) except with a list of errors
    
    Parameters:
    
    errorOrErrorKeys -
  - getGlobalValidationErrors
```
public List<String> getGlobalValidationErrors()
```
  - setGlobalValidationErrors
```
public void setGlobalValidationErrors(List<String> globalValidationErrors)
```
  - getActive
```
public Boolean getActive()
```
  - setActive
```
public void setActive(Boolean active)
```
  - getDeleted
```
public Boolean getDeleted()
```
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
  - getInactive
```
public Boolean getInactive()
```
  - setInactive
```
public void setInactive(Boolean inactive)
```
  - getDeployDate
```
public Date getDeployDate()
```
  - setDeployDate
```
public void setDeployDate(Date deployDate)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

type

properties

isDirty

deployDate

isDeleted

isInactive

isActive

multiPartAvailableOnThread

isValidationFailure

isPreAdd

validationErrors

globalValidationErrors

pMap

Constructor Detail

Entity

Method Detail

getType

setType

getPMap

getProperties

setProperties

mergeProperties

overridePropertyValues

findProperty

addProperty

removeProperty

addValidationError

isDirty

setDirty

isMultiPartAvailableOnThread

setMultiPartAvailableOnThread

isValidationFailure

setValidationFailure

isPreAdd

setIsPreAdd

getValidationErrors

getPropertyValidationErrors

setValidationErrors

setPropertyValidationErrors

addGlobalValidationError

addGlobalValidationErrors

getGlobalValidationErrors

setGlobalValidationErrors

getActive

setActive

getDeleted

setDeleted

getInactive

setInactive

getDeployDate

setDeployDate

toString

equals

hashCode