de.hybris.platform.hmc.jalo

Class HMCManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.hmc.jalo.GeneratedHMCManager

de.hybris.platform.hmc.jalo.HMCManager

All Implemented Interfaces:

Serializable

public class HMCManager
extends GeneratedHMCManager

This is the extension manager of the hmc extension.

Version:

ExtGen v1.3

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields

Modifier and Type	Field and Description
static String	HMC_STRUCTURE_DUMP_MEDIA
static String	HMC_STRUCTURE_MEDIA
static String	IS_HMC_SESSION

Fields inherited from class de.hybris.platform.hmc.jalo.GeneratedHMCManager

DEFAULT_INITIAL_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
HMCManager()

Method Summary

Modifier and Type	Method and Description
protected void	checkBeforeItemRemoval(SessionContext ctx, Item item) Superclass method overridden to avoid calls to ejb layer.
void	clearHMCStructure() Clears the structure media and the structure dump media as well as the old style db entry.
void	createEssentialData(Map params, JspContext jspc)
void	createProjectData(Map params, JspContext jspc)
protected Media	createStructureMedia()
WizardBusinessItem	createWizard(String wizardType)
WizardBusinessItem	createWizard(String wizardType, Map params)
protected Collection	filterRemovedItems(Object attributeValue)
Set<Language>	getAllDialogLanguages() Returns a Set containing all dialog (language for naming and so) languages for the current user.
Set<Language>	getAllLanguages() Returns all existing Language objects for the given JaloSession. Note: This set will be cached and rebuild per request.
Set<Language>	getAllReadableLanguages() Returns a Set containing all 'readable languages' for the current user as configured in its user profile.
Set<Language>	getAllWritableLanguages() Returns a Set containing all 'writable languages' for the current user as configured in its user profile.
protected Collection<ChangedItemAttributes>	getCreatedItemAttributes(Item item, Map<String,Object> values)
MediaFolder	getHMCMediaFolder() Gets the HMC specific MediaFolder used for storing hmc system medias.
static HMCManager	getInstance() NOTE: If extension.managersuperclass is set to 'PriceFactory' (i.e.
protected Collection<ChangedItemAttributes>	getModifiedItemAttributes(Item item, Map<String,Object> previousValues, Map<String,Object> newValues)
Media	getOrCreateStructureDumpMedia()
UserProfile	getOrCreateUserProfile() Gets the user profile of the current user.
protected Collection<ChangedItemAttributes>	getRemovedItemAttributes(Item item)
protected Collection<SavedValues>	getSavedValues(SessionContext ctx, Item item, int start, int count)
protected Media	getStructureMedia()
String	getStructureTimestamp()
String	getStructureXML() Returns the stored hmc xml structure once if it has been uploaded, otherwise null .
boolean	isCreatorDisabled() Part of DataCreator interface.
boolean	isHMCSession(SessionContext ctx)
protected boolean	isLoggingEnabled(Item toLog)
Boolean	isLogHMCChanges(SessionContext ctx, ComposedType item) Generated method - Getter of the ComposedType.logHMCChanges attribute.
protected boolean	isRemovalLoggingEnabled(Item item)
SavedValues	logItemCreation(Item item, Map values) Deprecated. use logItemCreation(PK, Map)
SavedValues	logItemCreation(PK itemPk, Map values) Creates a new SavedValues marking a item creation.
SavedValues	logItemModification(Item item, Map<String,Object> values, Map<String,Object> previousValues, boolean detectRemovedValues) Deprecated. use logItemModification(PK, Map, Map, boolean) instead
SavedValues	logItemModification(PK itemPk, Map<String,Object> values, Map<String,Object> previousValues, boolean detectRemovedValues) Creates a new SavedValues marking a item modification.
SavedValues	logItemRemoval(Item item, boolean saveAttributes) Deprecated. use logItemRemoval(PK, boolean) instead
SavedValues	logItemRemoval(PK itemPk, boolean saveAttributes) Creates a new SavedValues marking a item removal.
void	markHMCSession(JaloSession session) Deprecated.
protected void	notifyItemRemoval(SessionContext ctx, Item item) Superclass method overridden to avoid calls to ejb layer.
void	setStructureTimestamp(String timestamp) Changes the current hmc structure timestamp.
void	unmarkHMCSession(JaloSession session) Deprecated.
void	uploadStructureXML(String xml) Stores the given hmc xml structure.

Methods inherited from class de.hybris.platform.hmc.jalo.GeneratedHMCManager

createExportUserRightsWizard, createExportUserRightsWizard, createHMCHistoryEntry, createHMCHistoryEntry, createImportExportUserRightsWizard, createImportExportUserRightsWizard, createImportUserRightsWizard, createImportUserRightsWizard, createSampleWizard, createSampleWizard, createWizardBusinessItem, createWizardBusinessItem, getDefaultAttributeModes, getHmcIcon, getHmcIcon, getName, isHmcLoginDisabled, isHmcLoginDisabled, isHmcLoginDisabledAsPrimitive, isHmcLoginDisabledAsPrimitive, isLogHMCChanges, isLogHMCChangesAsPrimitive, isLogHMCChangesAsPrimitive, setHmcIcon, setHmcIcon, setHmcLoginDisabled, setHmcLoginDisabled, setHmcLoginDisabled, setHmcLoginDisabled, setLogHMCChanges, setLogHMCChanges, setLogHMCChanges, setLogHMCChanges

Methods inherited from class de.hybris.platform.jalo.extension.Extension

createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getRemote, notifyInitializationEnd, notifyInitializationStart, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

HMC_STRUCTURE_MEDIA

public static final String HMC_STRUCTURE_MEDIA

Since:

2.20

See Also:

Constant Field Values

HMC_STRUCTURE_DUMP_MEDIA

public static final String HMC_STRUCTURE_DUMP_MEDIA

See Also:

Constant Field Values

IS_HMC_SESSION

public static final String IS_HMC_SESSION

Since:

2.20

See Also:

Constant Field Values

Constructor Detail

HMCManager

public HMCManager()

Method Detail

getInstance

public static HMCManager getInstance()

NOTE: If extension.managersuperclass is set to 'PriceFactory' (i.e. you are using PriceFactory as superclass of this class), then you have to REMOVE the following getInstance() Method!! (PriceFactory already provides an implementation of getInstance).

Returns:

instance of this manager

getStructureXML

public String getStructureXML()

Returns the stored hmc xml structure once if it has been uploaded, otherwise null .

Since:

2.20

getStructureTimestamp

public String getStructureTimestamp()

Returns:

the current stored structure timestamp.

Since:

2.20

setStructureTimestamp

public void setStructureTimestamp(String timestamp)

Changes the current hmc structure timestamp.

Parameters:

timestamp - the new timestamp

Since:

2.20

getStructureMedia

protected Media getStructureMedia()

Since:

2.20

createStructureMedia

protected Media createStructureMedia()

Since:

2.20

uploadStructureXML

public void uploadStructureXML(String xml)

Stores the given hmc xml structure.

Parameters:

xml -

Since:

2.20

getOrCreateStructureDumpMedia

public Media getOrCreateStructureDumpMedia()

Since:

2.3

markHMCSession

@Deprecated
public void markHMCSession(JaloSession session)

Deprecated.

Since:

2.20

unmarkHMCSession

@Deprecated
public void unmarkHMCSession(JaloSession session)

Deprecated.

Since:

2.20

isHMCSession

public boolean isHMCSession(SessionContext ctx)

Since:

2.20

checkBeforeItemRemoval

protected void checkBeforeItemRemoval(SessionContext ctx,
                                      Item item)
                               throws ConsistencyCheckException

Superclass method overridden to avoid calls to ejb layer.

Overrides:

checkBeforeItemRemoval in class Extension

Parameters:

ctx - the current session context

item - the item which should be removed

Throws:

ConsistencyCheckException - thrown to abort removal due to consistency errors

Since:

2.10

isLogHMCChanges

public Boolean isLogHMCChanges(SessionContext ctx,
                               ComposedType item)

Description copied from class: GeneratedHMCManager

Generated method - Getter of the ComposedType.logHMCChanges attribute.

Overrides:

isLogHMCChanges in class GeneratedHMCManager

Returns:

the logHMCChanges - whether or not log changes to items of this type via hmc

isRemovalLoggingEnabled

protected boolean isRemovalLoggingEnabled(Item item)

Since:

2.20

notifyItemRemoval

protected void notifyItemRemoval(SessionContext ctx,
                                 Item item)

Superclass method overridden to avoid calls to ejb layer.

Overrides:

notifyItemRemoval in class Extension

Parameters:

ctx - the currency session context

item - the item which is going to be removed

Since:

2.10

isCreatorDisabled

public boolean isCreatorDisabled()

Part of DataCreator interface. This implementation returns false.

Overrides:

isCreatorDisabled in class Extension

Returns:

false

createWizard

public WizardBusinessItem createWizard(String wizardType)
                                throws JaloItemNotFoundException,
                                       JaloInvalidParameterException

Throws:

JaloItemNotFoundException

JaloInvalidParameterException

createWizard

public WizardBusinessItem createWizard(String wizardType,
                                       Map params)
                                throws JaloItemNotFoundException,
                                       JaloInvalidParameterException

Throws:

JaloItemNotFoundException

JaloInvalidParameterException

isLoggingEnabled

protected boolean isLoggingEnabled(Item toLog)

getSavedValues

protected Collection<SavedValues> getSavedValues(SessionContext ctx,
                                                 Item item,
                                                 int start,
                                                 int count)

logItemRemoval

@Deprecated
public SavedValues logItemRemoval(Item item,
                                              boolean saveAttributes)

Deprecated. use logItemRemoval(PK, boolean) instead

Creates a new SavedValues marking a item removal.

Parameters:

item - the removed item

saveAttributes - TODO

Since:

2.20

logItemRemoval

public SavedValues logItemRemoval(PK itemPk,
                                  boolean saveAttributes)

Creates a new SavedValues marking a item removal.

Parameters:

itemPk - the removed item

saveAttributes - TODO

Since:

2.20

filterRemovedItems

protected Collection filterRemovedItems(Object attributeValue)

Parameters:

attributeValue -

Returns:

a Collection with the removed items TODO: correct?

Since:

2.20

logItemModification

public SavedValues logItemModification(PK itemPk,
                                       Map<String,Object> values,
                                       Map<String,Object> previousValues,
                                       boolean detectRemovedValues)

Creates a new SavedValues marking a item modification.

Parameters:

itemPk - the created item

values - its modified values

previousValues - its previous values

detectRemovedValues - TODO

logItemModification

@Deprecated
public SavedValues logItemModification(Item item,
                                                   Map<String,Object> values,
                                                   Map<String,Object> previousValues,
                                                   boolean detectRemovedValues)

Deprecated. use logItemModification(PK, Map, Map, boolean) instead

Creates a new SavedValues marking a item modification.

Parameters:

item - the created item

values - its modified values

previousValues - its previous values

detectRemovedValues - TODO

getCreatedItemAttributes

protected Collection<ChangedItemAttributes> getCreatedItemAttributes(Item item,
                                                                     Map<String,Object> values)

getModifiedItemAttributes

protected Collection<ChangedItemAttributes> getModifiedItemAttributes(Item item,
                                                                      Map<String,Object> previousValues,
                                                                      Map<String,Object> newValues)

getRemovedItemAttributes

protected Collection<ChangedItemAttributes> getRemovedItemAttributes(Item item)

logItemCreation

@Deprecated
public SavedValues logItemCreation(Item item,
                                               Map values)

Deprecated. use logItemCreation(PK, Map)

Creates a new SavedValues marking a item creation.

Parameters:

item - the created item

values - its creation values

logItemCreation

public SavedValues logItemCreation(PK itemPk,
                                   Map values)

Creates a new SavedValues marking a item creation.

Parameters:

itemPk - the created item PK

values - its creation values

createEssentialData

public void createEssentialData(Map params,
                                JspContext jspc)
                         throws Exception

Overrides:

createEssentialData in class Extension

Throws:

Exception

getHMCMediaFolder

public MediaFolder getHMCMediaFolder()

Gets the HMC specific MediaFolder used for storing hmc system medias.

Returns:

folder for hmc specific medias

Since:

3.1-u4

createProjectData

public void createProjectData(Map params,
                              JspContext jspc)

Overrides:

createProjectData in class Extension

getOrCreateUserProfile

public UserProfile getOrCreateUserProfile()

Gets the user profile of the current user. If it is not created yet, it will be created.

Returns:

user profile of current user

getAllWritableLanguages

public Set<Language> getAllWritableLanguages()

Returns a Set containing all 'writable languages' for the current user as configured in its user profile. If no set is specified at the user profile all groups which the user is a member of will be searched for a property called 'writablelanguages' (which should contain Collections of Languages) and if such properties exist, all contained languages are returned.
Note: This set will be cached and rebuild per request.

Returns:

a Set containing all 'writable languages' for the current user.

getAllReadableLanguages

public Set<Language> getAllReadableLanguages()

Returns a Set containing all 'readable languages' for the current user as configured in its user profile. If no set is specified at the user profile all groups which the user is a member of will be searched for a property called 'readablelanguages' (which should contain Collections of Languages) and if such properties exist, all contained languages are returned.
Note: This set will be cached and rebuild per request.

Returns:

a Set containing all 'readable languages' for the current user.

getAllDialogLanguages

public Set<Language> getAllDialogLanguages()

Returns a Set containing all dialog (language for naming and so) languages for the current user. The call gives the same result as getAllLanguages(). Note: This set will be cached and rebuild

Returns:

a Set containing all 'dialog languages' for the current user.

getAllLanguages

public Set<Language> getAllLanguages()

Returns all existing Language objects for the given JaloSession.
Note: This set will be cached and rebuild per request.

Returns:

a Set containing all existing Language objects for the given JaloSession.

clearHMCStructure

public void clearHMCStructure()

Clears the structure media and the structure dump media as well as the old style db entry. Currently used by initialization process.

Since:

3.1-u6