org.broadleafcommerce.admin.server.service.persistence.module.provider

Class TypedEntityFieldPersistenceProvider

java.lang.Object

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.AbstractFieldPersistenceProvider

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProviderAdapter

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.DefaultFieldPersistenceProvider

org.broadleafcommerce.admin.server.service.persistence.module.provider.TypedEntityFieldPersistenceProvider

All Implemented Interfaces:

FieldPersistenceProvider, org.springframework.core.Ordered

@Component(value="blTypedEntityFieldPersistenceProvider")
 @Scope(value="prototype")
public class TypedEntityFieldPersistenceProvider
extends DefaultFieldPersistenceProvider

This field persistence provider manages the type field for TypedEntitys and ensures that they are always marked as dirty when they change, regardless of PreAdd state.

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields inherited from interface org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProvider

BASIC, HTML, MAP_FIELD, MEDIA, MONEY, RULE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
TypedEntityFieldPersistenceProvider()

Method Summary

Modifier and Type	Method and Description
protected boolean	canHandlePersistence(PopulateValueRequest populateValueRequest, Serializable instance)
protected boolean	checkDirtyState(PopulateValueRequest request, Object instance, Object checkValue)
MetadataProviderResponse	extractValue(ExtractValueRequest extractValueRequest, Property property) Retrieve the property value from the requestedValue field from the request.
int	getOrder()
MetadataProviderResponse	populateValue(PopulateValueRequest populateValueRequest, Serializable instance) Set the property value on the target object.

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProviderAdapter

addSearchMapping, filterProperties, isFieldDirty, setNonDisplayableValues

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.AbstractFieldPersistenceProvider

alwaysRun, buildFieldInfo, canHandlePopulateNull, getListFieldType, getMapFieldType

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedEntityFieldPersistenceProvider

public TypedEntityFieldPersistenceProvider()

Method Detail

populateValue

public MetadataProviderResponse populateValue(PopulateValueRequest populateValueRequest,
                                              Serializable instance)

Description copied from interface: FieldPersistenceProvider

Set the property value on the target object. Implementations should translate the requestedValue field from the request and set on the instance parameter. You are basically taking the string value submitted by the admin application and converting it into the format required to set on the target field of instance (which should be a JPA managed entity). Used during admin create and update events.

Specified by:

populateValue in interface FieldPersistenceProvider

Overrides:

populateValue in class DefaultFieldPersistenceProvider

Parameters:

populateValueRequest - contains the requested value and support classes.

instance - the persistence entity instance on which to set the value harvested from the request

Returns:

whether or not the implementation handled the persistence request

extractValue

public MetadataProviderResponse extractValue(ExtractValueRequest extractValueRequest,
                                             Property property)
                                      throws PersistenceException

Description copied from interface: FieldPersistenceProvider

Retrieve the property value from the requestedValue field from the request. Implementations should translate the requestedValue and set on the property parameter. The requestedValue is the field value taken from the JPA managed entity instance. You are taking this field value and converting it into a string representation appropriate for the property instance parameter. Used during admin fetch events.

Specified by:

extractValue in interface FieldPersistenceProvider

Overrides:

extractValue in class DefaultFieldPersistenceProvider

Parameters:

extractValueRequest - contains the requested value and support classes.

property - the property for the admin that will contain the information harvested from the persistence value

Returns:

whether or not the implementation handled the persistence request

Throws:

PersistenceException

checkDirtyState

protected boolean checkDirtyState(PopulateValueRequest request,
                                  Object instance,
                                  Object checkValue)
                           throws Exception

Overrides:

checkDirtyState in class FieldPersistenceProviderAdapter

Throws:

Exception

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class FieldPersistenceProviderAdapter

canHandlePersistence

protected boolean canHandlePersistence(PopulateValueRequest populateValueRequest,
                                       Serializable instance)