umun.entity.service

Class EntityPrefService<ENTITY extends umun.iam.model.Meta,PREF extends EntityPref,ID extends EntityPrefId>

java.lang.Object

umun.entity.service.EntityPrefService<ENTITY,PREF,ID>

Direct Known Subclasses:

NamedEntityPrefService, SystemDefaultPrefService, TablePrefService

public abstract class EntityPrefService<ENTITY extends umun.iam.model.Meta,PREF extends EntityPref,ID extends EntityPrefId>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityPrefCategoryService	categoryService
EntityPrefCategory	rootCategory
protected umun.core.service.SystemPrefService	systemPrefService

Constructor Summary

Constructors

Constructor and Description
EntityPrefService()

Method Summary

Modifier and Type	Method and Description
void	addRootKeys(String rootKey, String defaultValue, String remoteHideKey, PrefDataType dataType, EntityPrefOptionsInterface optionsInterface, String displayName, EntityPrefValidationInterface<ENTITY,PREF> entityPrefValidationInterface, String group, boolean defaultRemoteHide, EntityPrefProp<ENTITY,PREF> properties)
void	addServiceReference(String categoryName, EntityPrefCategoryInterface<ENTITY,PREF,ID,?> instance)
protected abstract PREF	createCategoryAsPref(ENTITY entity, EntityPrefCategory category)
protected abstract ID	createEntityPrefId(ENTITY entity, EntityPrefCategory category, String key)
protected abstract PREF	createMissingRootPref(ENTITY entity, EntityPrefCategory rootCategory, String key, EntityPrefValue<ENTITY,PREF> value, Map<String,String> options, String group)
PREF	createOrUpdate(ENTITY entity, EntityPrefCategory category, String key, String value, umun.iam.model.User requestedBy)
protected abstract PREF	createPref(ENTITY entity, EntityPrefCategory category, String key, String value, String remoteHideKey)
protected PREF	doPostCreationOperations(ENTITY entity, EntityPrefCategory category, PREF pref, String key, String value, umun.iam.model.User requestedBy)
protected PREF	doPostFoundOperations(PREF pref, EntityPrefValue<ENTITY,PREF> value, ENTITY entity)
protected abstract List<PREF>	findByEntityAndCategoryOrderByKey(ENTITY entity, EntityPrefCategory rootCategory)
protected abstract ENTITY	findEntityOrFail(long entityId, umun.iam.model.User requestedBy)
ENTITY	findOne(long entityId, umun.iam.model.User requestedBy)
protected abstract Map<String,EntityPrefCategoryInterface<ENTITY,PREF,ID,?>>	getCategoryServicesMap()
List<TemplatePref>	getCreationTemplate(Map<String,String> allRequestParams)
protected abstract EntityCRUDService<ENTITY>	getCrudService()
protected PrefDataType	getDataType(EntityPrefCategory category, String key)
protected String	getDisplayname(String key)
protected abstract String	getEntityName()
protected String	getGroup(EntityPrefCategory category, String key)
protected Map<String,String>	getOptions(EntityPrefCategory category, String key, ENTITY entity)
protected String	getRemoteHideKey(EntityPrefCategory category, String key)
protected abstract EntityPrefRepository<PREF,ID>	getRepository()
protected abstract Map<String,EntityPrefValue<ENTITY,PREF>>	getRootKeys()
protected boolean	isDoNotAddIfMissing(String key, ENTITY entity)
List<PREF>	read(ENTITY entity)
List<PREF>	read(ENTITY entity, EntityPrefCategory category)
protected PREF	read(ID entityPrefId)
List<PREF>	read(long entityId, umun.iam.model.User requestedBy)
List<PREF>	read(umun.iam.model.User requestedBy, long categoryId, long entityId)
Map<String,List<PREF>>	readAllPrefs(umun.iam.model.User requestedBy, long entityId)
PREF	readOrFail(ENTITY entity, EntityPrefCategory category, String key)
PREF	readWithoutFail(ENTITY entity, EntityPrefCategory category, String key, String value)
protected List<PREF>	removeHidden(List<PREF> prefs)
protected PREF	saveAndFlush(ENTITY entity, EntityPrefCategory category, PREF pref, String key, String value, umun.iam.model.User requestedBy, String oldValue)
void	startUp(org.springframework.context.event.ContextRefreshedEvent event)
PREF	update(long entityId, long categoryId, String key, String value, umun.iam.model.User requestedBy)
String	validate(String key, EntityPref value)
protected void	validateCreateOrUpdate(ENTITY entity, EntityPrefCategory category, String key, String value, umun.iam.model.User requestedBy, PREF pref)

Methods inherited from class java.lang.Object

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

Field Detail

rootCategory

public EntityPrefCategory rootCategory

categoryService

@Autowired
protected EntityPrefCategoryService categoryService

systemPrefService

@Autowired
protected umun.core.service.SystemPrefService systemPrefService

Constructor Detail

EntityPrefService

public EntityPrefService()

Method Detail

getRepository

protected abstract EntityPrefRepository<PREF,ID> getRepository()

getCategoryServicesMap

protected abstract Map<String,EntityPrefCategoryInterface<ENTITY,PREF,ID,?>> getCategoryServicesMap()

getRootKeys

protected abstract Map<String,EntityPrefValue<ENTITY,PREF>> getRootKeys()

findByEntityAndCategoryOrderByKey

protected abstract List<PREF> findByEntityAndCategoryOrderByKey(ENTITY entity,
                                                                EntityPrefCategory rootCategory)

createMissingRootPref

protected abstract PREF createMissingRootPref(ENTITY entity,
                                              EntityPrefCategory rootCategory,
                                              String key,
                                              EntityPrefValue<ENTITY,PREF> value,
                                              Map<String,String> options,
                                              String group)

createCategoryAsPref

protected abstract PREF createCategoryAsPref(ENTITY entity,
                                             EntityPrefCategory category)
                                      throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

createEntityPrefId

protected abstract ID createEntityPrefId(ENTITY entity,
                                         EntityPrefCategory category,
                                         String key)

createPref

protected abstract PREF createPref(ENTITY entity,
                                   EntityPrefCategory category,
                                   String key,
                                   String value,
                                   String remoteHideKey)
                            throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

findEntityOrFail

protected abstract ENTITY findEntityOrFail(long entityId,
                                           umun.iam.model.User requestedBy)
                                    throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getEntityName

protected abstract String getEntityName()

getCrudService

protected abstract EntityCRUDService<ENTITY> getCrudService()

startUp

@EventListener
public void startUp(org.springframework.context.event.ContextRefreshedEvent event)

addRootKeys

public void addRootKeys(String rootKey,
                        String defaultValue,
                        String remoteHideKey,
                        PrefDataType dataType,
                        EntityPrefOptionsInterface optionsInterface,
                        String displayName,
                        EntityPrefValidationInterface<ENTITY,PREF> entityPrefValidationInterface,
                        String group,
                        boolean defaultRemoteHide,
                        EntityPrefProp<ENTITY,PREF> properties)

addServiceReference

public void addServiceReference(String categoryName,
                                EntityPrefCategoryInterface<ENTITY,PREF,ID,?> instance)

createOrUpdate

public PREF createOrUpdate(ENTITY entity,
                           EntityPrefCategory category,
                           String key,
                           String value,
                           umun.iam.model.User requestedBy)
                    throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

saveAndFlush

protected PREF saveAndFlush(ENTITY entity,
                            EntityPrefCategory category,
                            PREF pref,
                            String key,
                            String value,
                            umun.iam.model.User requestedBy,
                            String oldValue)

validateCreateOrUpdate

protected void validateCreateOrUpdate(ENTITY entity,
                                      EntityPrefCategory category,
                                      String key,
                                      String value,
                                      umun.iam.model.User requestedBy,
                                      PREF pref)
                               throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

doPostCreationOperations

protected PREF doPostCreationOperations(ENTITY entity,
                                        EntityPrefCategory category,
                                        PREF pref,
                                        String key,
                                        String value,
                                        umun.iam.model.User requestedBy)
                                 throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

read

public List<PREF> read(long entityId,
                       umun.iam.model.User requestedBy)
                throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

read

public List<PREF> read(umun.iam.model.User requestedBy,
                       long categoryId,
                       long entityId)
                throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

read

public List<PREF> read(ENTITY entity,
                       EntityPrefCategory category)

readAllPrefs

public Map<String,List<PREF>> readAllPrefs(umun.iam.model.User requestedBy,
                                           long entityId)
                                    throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

read

public List<PREF> read(ENTITY entity)

readWithoutFail

public PREF readWithoutFail(ENTITY entity,
                            EntityPrefCategory category,
                            String key,
                            String value)
                     throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

readOrFail

public PREF readOrFail(ENTITY entity,
                       EntityPrefCategory category,
                       String key)
                throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getCreationTemplate

public List<TemplatePref> getCreationTemplate(Map<String,String> allRequestParams)

validate

public String validate(String key,
                       EntityPref value)
                throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

findOne

public ENTITY findOne(long entityId,
                      umun.iam.model.User requestedBy)
               throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

read

protected PREF read(ID entityPrefId)

update

public PREF update(long entityId,
                   long categoryId,
                   String key,
                   String value,
                   umun.iam.model.User requestedBy)
            throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getRemoteHideKey

protected String getRemoteHideKey(EntityPrefCategory category,
                                  String key)
                           throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getDataType

protected PrefDataType getDataType(EntityPrefCategory category,
                                   String key)
                            throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getOptions

protected Map<String,String> getOptions(EntityPrefCategory category,
                                        String key,
                                        ENTITY entity)
                                 throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getGroup

protected String getGroup(EntityPrefCategory category,
                          String key)
                   throws umun.core.constants.ValidationException

Throws:

umun.core.constants.ValidationException

getDisplayname

protected String getDisplayname(String key)

removeHidden

protected List<PREF> removeHidden(List<PREF> prefs)

doPostFoundOperations

protected PREF doPostFoundOperations(PREF pref,
                                     EntityPrefValue<ENTITY,PREF> value,
                                     ENTITY entity)

isDoNotAddIfMissing

protected boolean isDoNotAddIfMissing(String key,
                                      ENTITY entity)