Package ch.tocco.nice2.persist.history.impl.v2.config

Class DefaultEntityHistoryConfig

java.lang.Object

ch.tocco.nice2.persist.history.impl.v2.config.DefaultEntityHistoryConfig

All Implemented Interfaces:

EntityHistoryConfiguration

@Component
public class DefaultEntityHistoryConfig
extends Object
implements EntityHistoryConfiguration

The default history configuration. All fields are included except 'auto'-fields, 'password' type fields and explicitly excluded fields. Only relations to lookup entities are included.

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.persist.history.api.v2.EntityHistoryConfiguration

EntityHistoryConfiguration.RelationDefinition

Constructor Summary

Constructors

Constructor	Description
DefaultEntityHistoryConfig()

Method Summary

Modifier and Type	Method	Description
List<FieldModel>	getIncludedFields(EntityModel entityModel)
List<EntityHistoryConfiguration.RelationDefinition>	getIncludedRelations(Entity centerEntity)
boolean	isApplicableForHistory(EntityFacadeEvent event)
int	priority()
void	setHistoryRelationInclusionConfigs(List<HistoryRelationInclusionContribution> contributions)
void	setIgnoreEntityModels(List<HistoryExclusionContribution> contributions)
boolean	supports(EntityModel entityModel, boolean isRootEntity)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEntityHistoryConfig

public DefaultEntityHistoryConfig()

Method Details

setIgnoreEntityModels

@Autowired
public void setIgnoreEntityModels(List<HistoryExclusionContribution> contributions)

setHistoryRelationInclusionConfigs

@Autowired(required=false)
public void setHistoryRelationInclusionConfigs(List<HistoryRelationInclusionContribution> contributions)

supports

public boolean supports(EntityModel entityModel,
 boolean isRootEntity)

Specified by:

supports in interface EntityHistoryConfiguration

Returns:

true if EntityHistoryConfiguration supports this entity model. `isRootEntity` is used to distinguish between a lookup entity itself is changed and the full xml should be generated or a related entity is changed and only some fields should be in the xml.

priority

public int priority()

Specified by:

priority in interface EntityHistoryConfiguration

isApplicableForHistory

public boolean isApplicableForHistory(EntityFacadeEvent event)

Specified by:

isApplicableForHistory in interface EntityHistoryConfiguration

Returns:

true if the given event should trigger the creation of a history entry

getIncludedFields

public List<FieldModel> getIncludedFields(EntityModel entityModel)

Specified by:

getIncludedFields in interface EntityHistoryConfiguration

Returns:

which fields should be included in the history snapshot for the given entity model

getIncludedRelations

public List<EntityHistoryConfiguration.RelationDefinition> getIncludedRelations(Entity centerEntity)

Specified by:

getIncludedRelations in interface EntityHistoryConfiguration

Returns:

which relations should be included in the history snapshot for the given entity model