de.hybris.platform.cockpit.helpers.impl

Class DefaultModelHelper

java.lang.Object

de.hybris.platform.cockpit.helpers.impl.DefaultModelHelper

All Implemented Interfaces:

ModelHelper

public class DefaultModelHelper
extends java.lang.Object
implements ModelHelper

Default implementation of the model helper.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultModelHelper.ModificationInfo

Constructor Summary

Constructors

Constructor and Description
DefaultModelHelper()

Method Summary

Modifier and Type	Method and Description
protected void	checkUserRights(ItemModel model, DefaultModelHelper.ModificationInfo modificationInfo)
protected void	checkUserRights(ItemModel model, java.lang.String attribute, boolean creationMode)
protected void	createUndoOperation(ItemModel model, DefaultModelHelper.ModificationInfo modificationInfo)
protected void	createUndoOperations(java.util.Set<DefaultModelHelper.ModificationInfo> modificationInfos)
protected CommonI18NService	getCommonI18NService()
protected I18NService	getI18nService()
protected LocalizationService	getLocalizationService() Deprecated. since 6.3
protected ModelService	getModelService()
protected DefaultModelHelper.ModificationInfo	getModificationInfo(ItemModel model)
protected java.lang.Object	getOriginalValue(ItemModel model, java.lang.String attribute, java.util.Locale locale, ModelValueHistory history)
protected java.lang.Object	getOriginalValue(ItemModel model, java.lang.String attribute, ModelValueHistory history)
protected SystemService	getSystemService()
protected TypeService	getTypeService()
protected UIAccessRightService	getUiAccessRightService()
protected UndoManager	getUndoManager()
boolean	isWritable(ItemModel model, java.lang.String attribute, boolean creationMode) Checks write permissions for the given item and attribute.
protected void	logModifications(ItemModel model, DefaultModelHelper.ModificationInfo modificationInfo)
void	removeModel(ItemModel model, boolean createUndoOperation) Removes the given model and creates a change log entry.
void	removeModel(ItemModel model, boolean createUndoOperation, boolean sendChangeEvents) Removes the given model and creates a change log entry.
void	saveModel(ItemModel model, boolean createUndoOperations) Saves the given model and creates a change log entry.
void	saveModel(ItemModel model, boolean createUndoOperations, boolean sendChangeEvents) Saves the given model and creates a change log entry.
void	saveModels(java.util.Set<ItemModel> models, boolean createUndoOperations) Saves given models and creates change log entry for each modification.
void	saveModels(java.util.Set<ItemModel> models, boolean createUndoOperations, boolean sendChangeEvents) Saves given models and creates change log entry for each modification.
protected void	sendItemChangeEvent(ItemModel model, DefaultModelHelper.ModificationInfo modificationInfo)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setI18nService(I18NService i18nService)
void	setLocalizationService(LocalizationService localizationService) Deprecated. since 6.3
void	setModelService(ModelService modelService)
void	setSystemService(SystemService systemService)
void	setTypeService(TypeService typeService)
void	setUiAccessRightService(UIAccessRightService uiAccessRightService)
void	setUndoManager(UndoManager undoManager)
protected boolean	valuesEqual(java.lang.Object value1, java.lang.Object value2, boolean localized)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModelHelper

public DefaultModelHelper()

Method Detail

saveModel

public void saveModel(ItemModel model,
                      boolean createUndoOperations)
               throws ValueHandlerException

Description copied from interface: ModelHelper

Saves the given model and creates a change log entry. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

saveModel in interface ModelHelper

Parameters:

model - the model to save

createUndoOperations - undo operation will be created if set to true

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

saveModel

public void saveModel(ItemModel model,
                      boolean createUndoOperations,
                      boolean sendChangeEvents)
               throws ValueHandlerException

Description copied from interface: ModelHelper

Saves the given model and creates a change log entry. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

saveModel in interface ModelHelper

Parameters:

model - the model to save

createUndoOperations - undo operation will be created if set to true

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

saveModels

public void saveModels(java.util.Set<ItemModel> models,
                       boolean createUndoOperations)
                throws ValueHandlerException

Description copied from interface: ModelHelper

Saves given models and creates change log entry for each modification. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

saveModels in interface ModelHelper

Parameters:

models - models to save

createUndoOperations - undo operation will be created if set to true

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

saveModels

public void saveModels(java.util.Set<ItemModel> models,
                       boolean createUndoOperations,
                       boolean sendChangeEvents)
                throws ValueHandlerException

Description copied from interface: ModelHelper

Saves given models and creates change log entry for each modification. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

saveModels in interface ModelHelper

Parameters:

models - models to save

createUndoOperations - undo operation will be created if set to true

sendChangeEvents - if true, item change events will be sent

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

sendItemChangeEvent

protected void sendItemChangeEvent(ItemModel model,
                                   DefaultModelHelper.ModificationInfo modificationInfo)

checkUserRights

protected void checkUserRights(ItemModel model,
                               DefaultModelHelper.ModificationInfo modificationInfo)
                        throws ValueHandlerException

Throws:

ValueHandlerException

checkUserRights

protected void checkUserRights(ItemModel model,
                               java.lang.String attribute,
                               boolean creationMode)
                        throws ValueHandlerException

Throws:

ValueHandlerException

getModificationInfo

protected DefaultModelHelper.ModificationInfo getModificationInfo(ItemModel model)

getOriginalValue

protected java.lang.Object getOriginalValue(ItemModel model,
                                            java.lang.String attribute,
                                            ModelValueHistory history)

getOriginalValue

protected java.lang.Object getOriginalValue(ItemModel model,
                                            java.lang.String attribute,
                                            java.util.Locale locale,
                                            ModelValueHistory history)

logModifications

protected void logModifications(ItemModel model,
                                DefaultModelHelper.ModificationInfo modificationInfo)

createUndoOperations

protected void createUndoOperations(java.util.Set<DefaultModelHelper.ModificationInfo> modificationInfos)

createUndoOperation

protected void createUndoOperation(ItemModel model,
                                   DefaultModelHelper.ModificationInfo modificationInfo)

removeModel

public void removeModel(ItemModel model,
                        boolean createUndoOperation)
                 throws ValueHandlerException

Description copied from interface: ModelHelper

Removes the given model and creates a change log entry. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

removeModel in interface ModelHelper

Parameters:

model - the model to remove

createUndoOperation - undo operation will be created if set to true

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

removeModel

public void removeModel(ItemModel model,
                        boolean createUndoOperation,
                        boolean sendChangeEvents)
                 throws ValueHandlerException

Description copied from interface: ModelHelper

Removes the given model and creates a change log entry. It also checks user rights and if this check fails the ValueHandlerException will be thrown.

Specified by:

removeModel in interface ModelHelper

Parameters:

model - the model to remove

createUndoOperation - undo operation will be created if set to true

sendChangeEvents - if true, item change events will be sent

Throws:

ValueHandlerException - when problem occurs, e.g. user rights check fails

isWritable

public boolean isWritable(ItemModel model,
                          java.lang.String attribute,
                          boolean creationMode)

Description copied from interface: ModelHelper

Checks write permissions for the given item and attribute.

Specified by:

isWritable in interface ModelHelper

Parameters:

model - the item to check permission for

attribute - the attribute to check permission for

creationMode - creation mode

Returns:

true if write possible, false otherwise

valuesEqual

protected boolean valuesEqual(java.lang.Object value1,
                              java.lang.Object value2,
                              boolean localized)

setModelService

public void setModelService(ModelService modelService)

getModelService

protected ModelService getModelService()

setTypeService

public void setTypeService(TypeService typeService)

getTypeService

protected TypeService getTypeService()

setSystemService

public void setSystemService(SystemService systemService)

getSystemService

protected SystemService getSystemService()

setUiAccessRightService

public void setUiAccessRightService(UIAccessRightService uiAccessRightService)

getUiAccessRightService

protected UIAccessRightService getUiAccessRightService()

setI18nService

public void setI18nService(I18NService i18nService)

getI18nService

protected I18NService getI18nService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setLocalizationService

@Deprecated
public void setLocalizationService(LocalizationService localizationService)

Deprecated. since 6.3

getLocalizationService

@Deprecated
protected LocalizationService getLocalizationService()

Deprecated. since 6.3

setUndoManager

public void setUndoManager(UndoManager undoManager)

getUndoManager

protected UndoManager getUndoManager()