de.hybris.platform.catalog.hmc

Class CatalogHMCExtension

java.lang.Object

de.hybris.platform.hmc.extension.HMCExtension

de.hybris.platform.catalog.hmc.CatalogHMCExtension

public class CatalogHMCExtension
extends HMCExtension

Provides necessary meta information about the catalog hmc extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
CatalogHMCExtension()

Method Summary

Modifier and Type	Method and Description
EditorNode	adjustEditorConfiguration(EditorNode defaultNode, ComposedType type, Item forItem) Allows to provide a customized EditorNode for each item instead of using one for all items (depending upon their type).
ActionResult	beforeCreate(ComposedType itemType, DisplayState displayState, Map initialValues)
ActionResult	beforeSave(Item item, DisplayState displayState, Map currentValues, Map initialValues) The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.
ActionResult	checkAllowedToWriteCatalogVersion(Item item, ComposedType itemType, Map values) Checks if session user has proper write permission to the catalog version.
ActionResult	checkNonEmployeesMemberPrincipals(Map values)
ActionResult	checkPossibleInitWithDefaultCatalogVersion(Map values, ComposedType itemType) Checks if the item could be initialized with default catalog version.
static ClassificationAttributeEditorChipFactory	getClassificationAttributeEditorChipFactory()
List	getEditorTabChips(DisplayState displayState, AbstractEditorMenuChip parent)
ResourceBundle	getLocalizeResourceBundle(Locale locale) Should return the resource bundle for the extension and the given locale.
List	getMenuEntrySlotEntries(DisplayState displayState, Chip parent)
String	getResourcePath() Should return the path to the resource bundle.
List	getSectionChips(DisplayState displayState, ClipChip parent)
List	getToolbarActionChips(DisplayState displayState, Chip parent)
List	getTreeNodeChips(DisplayState displayState, Chip parent)

Methods inherited from class de.hybris.platform.hmc.extension.HMCExtension

adjustToolbarActionChips, afterCreate, afterRemove, afterSave, afterSave, beforeRemove, notifySessionBegin

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

Constructor Detail

CatalogHMCExtension

public CatalogHMCExtension()

Method Detail

adjustEditorConfiguration

public EditorNode adjustEditorConfiguration(EditorNode defaultNode,
                                            ComposedType type,
                                            Item forItem)

Description copied from class: HMCExtension

Allows to provide a customized EditorNode for each item instead of using one for all items (depending upon their type).

Overrides:

adjustEditorConfiguration in class HMCExtension

Parameters:

defaultNode - the default editor node chosen by item type

type - the item type

forItem - the actual item to open an editor for

Returns:

the editor node which creates/configures the item editor; as default this method simply passes the default node

getTreeNodeChips

public List getTreeNodeChips(DisplayState displayState,
                             Chip parent)

Specified by:

getTreeNodeChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent AbstractExplorerMenuTreeNodeChip

Returns:

List of AbstractExplorerMenuTreeNodeChips.

getMenuEntrySlotEntries

public List getMenuEntrySlotEntries(DisplayState displayState,
                                    Chip parent)

Specified by:

getMenuEntrySlotEntries in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of MenuEntrySlotEntry.

getSectionChips

public List getSectionChips(DisplayState displayState,
                            ClipChip parent)

Specified by:

getSectionChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent ClipChip

Returns:

List of ClipChips.

getEditorTabChips

public List getEditorTabChips(DisplayState displayState,
                              AbstractEditorMenuChip parent)

Specified by:

getEditorTabChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent AbstractEditorMenuChip

Returns:

List of EditorTabChip

getToolbarActionChips

public List getToolbarActionChips(DisplayState displayState,
                                  Chip parent)

Specified by:

getToolbarActionChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of ToolbarActionChips.

getLocalizeResourceBundle

public ResourceBundle getLocalizeResourceBundle(Locale locale)

Description copied from class: HMCExtension

Should return the resource bundle for the extension and the given locale. If there is no resource bundle, i.e because there are no special messages used this method should throw a MissingResourceException.

Specified by:

getLocalizeResourceBundle in class HMCExtension

Returns:

The resource bundle containing the localized strings and their values for the given locale. Cannot be NULL.

getResourcePath

public String getResourcePath()

Description copied from class: HMCExtension

Should return the path to the resource bundle.

Specified by:

getResourcePath in class HMCExtension

Returns:

The path of the resource bundle containing the localized strings and their values.

beforeCreate

public ActionResult beforeCreate(ComposedType itemType,
                                 DisplayState displayState,
                                 Map initialValues)

Overrides:

beforeCreate in class HMCExtension

beforeSave

public ActionResult beforeSave(Item item,
                               DisplayState displayState,
                               Map currentValues,
                               Map initialValues)

Description copied from class: HMCExtension

The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.

Overrides:

beforeSave in class HMCExtension

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

currentValues - Map containing all current attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

initialValues - Map containing all initial attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

Returns:

ActionResult with processing informations ( action processed successful etc )

checkAllowedToWriteCatalogVersion

public ActionResult checkAllowedToWriteCatalogVersion(Item item,
                                                      ComposedType itemType,
                                                      Map values)

Checks if session user has proper write permission to the catalog version.

checkPossibleInitWithDefaultCatalogVersion

public ActionResult checkPossibleInitWithDefaultCatalogVersion(Map values,
                                                               ComposedType itemType)

Checks if the item could be initialized with default catalog version.

checkNonEmployeesMemberPrincipals

public ActionResult checkNonEmployeesMemberPrincipals(Map values)

getClassificationAttributeEditorChipFactory

public static ClassificationAttributeEditorChipFactory getClassificationAttributeEditorChipFactory()