de.hybris.platform.hmc.extension

Class HMCExtension

java.lang.Object

de.hybris.platform.hmc.extension.HMCExtension

Direct Known Subclasses:

ASQHMCExtension, B2BAcceleratorServicesHMCExtension, B2BApprovalprocessHMCExtension, B2BCommerceHMCExtension, BasecommerceHMCExtension, BMECatHMCExtension, BtgHMCExtension, CatalogHMCExtension, CategoryHMCExtension, ClassificationsystemsHMCExtension, Cms2HMCExtension, CockpitHMCExtension, CommentsHMCExtension, CommercesearchhmcHMCExtension, CommonsHMCExtension, CronJobHMCExtension, CustomerReviewHMCExtension, Europe1HMCExtension, HybrisDataSupplierHMCExtension, ImpExHMCExtension, ImportCockpitHMCExtension, LDAPHMCExtension, LucenesearchHMCExtension, MccHMCExtension, MediaConversionHMCExtension, MobileHMCExtension, MobileoptionalsHMCExtension, OndemandcommonHMCExtension, PlatformHMCExtension, PrintcockpitHMCExtension, PrintHMCExtension, ProcessengineHMCExtension, ProcessingHMCExtension, PromotionsHMCExtension, SapproductconfigHMCExtension, ScriptingHMCExtension, ServicelayerHMCExtension, SolrfacetsearchHMCExtension, StandardPaymentModeHMCExtension, SubscriptionservicesHMCExtension, TicketsystemHMCExtension, ValidationHMCExtension, VariantsHMCExtension, VoucherHMCExtension, WorkflowHMCExtension, Y2YSyncHMCExtension, ZoneDeliveryModeHMCExtension

public abstract class HMCExtension
extends Object

Abstract class for HMC Extensions. All extensions have to implement a class as subclass of this, which is listed in the hmcextension file.

Constructor Summary

Constructors

Constructor and Description
HMCExtension()

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).
void	adjustToolbarActionChips(List<AbstractToolbarActionChip> toolbarActions, JaloSession session) If you want to remove specific toolbar actions from the main toolbar (maybe based on the current user) then you can implement this method in your extension and simply remove the actions from the provided list.
ActionResult	afterCreate(Item item, DisplayState displayState, Map initialValues, Map values, ActionResult actionResult)
ActionResult	afterRemove(ComposedType itemType, DisplayState displayState, Map values, ActionResult actionResult)
ActionResult	afterSave(Item item, DisplayState displayState, Map currentValues, ActionResult actionResult)
ActionResult	afterSave(Item item, DisplayState displayState, Map currentValues, Map initialValues, ActionResult actionResult)
ActionResult	beforeCreate(ComposedType itemType, DisplayState displayState, Map initialValues)
ActionResult	beforeRemove(Item item, ComposedType itemType, DisplayState displayState, Map values)
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.
abstract List<EditorTabChip>	getEditorTabChips(DisplayState displayState, AbstractEditorMenuChip parent)
abstract ResourceBundle	getLocalizeResourceBundle(Locale locale) Should return the resource bundle for the extension and the given locale.
abstract List<MenuEntrySlotEntry>	getMenuEntrySlotEntries(DisplayState displayState, Chip parent)
abstract String	getResourcePath() Should return the path to the resource bundle.
abstract List<ClipChip>	getSectionChips(DisplayState displayState, ClipChip parent)
abstract List<ToolbarActionChip>	getToolbarActionChips(DisplayState displayState, Chip parent)
abstract List<AbstractExplorerMenuTreeNodeChip>	getTreeNodeChips(DisplayState displayState, Chip parent)
void	notifySessionBegin(DisplayState displayState, JaloSession jaloSession, HttpServletRequest request) In your HMCExtension class you can implement this method to be notified of any new hmc session which is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

HMCExtension

public HMCExtension()

Method Detail

getEditorTabChips

public abstract List<EditorTabChip> getEditorTabChips(DisplayState displayState,
                                                      AbstractEditorMenuChip parent)

Parameters:

displayState - the current DisplayState

parent - the parent AbstractEditorMenuChip

Returns:

List of EditorTabChip

getTreeNodeChips

public abstract List<AbstractExplorerMenuTreeNodeChip> getTreeNodeChips(DisplayState displayState,
                                                                        Chip parent)

Parameters:

displayState - the current DisplayState

parent - the parent AbstractExplorerMenuTreeNodeChip

Returns:

List of AbstractExplorerMenuTreeNodeChips.

getMenuEntrySlotEntries

public abstract List<MenuEntrySlotEntry> getMenuEntrySlotEntries(DisplayState displayState,
                                                                 Chip parent)

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of MenuEntrySlotEntry.

getSectionChips

public abstract List<ClipChip> getSectionChips(DisplayState displayState,
                                               ClipChip parent)

Parameters:

displayState - the current DisplayState

parent - the parent ClipChip

Returns:

List of ClipChips.

getToolbarActionChips

public abstract List<ToolbarActionChip> getToolbarActionChips(DisplayState displayState,
                                                              Chip parent)

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of ToolbarActionChips.

adjustToolbarActionChips

public void adjustToolbarActionChips(List<AbstractToolbarActionChip> toolbarActions,
                                     JaloSession session)

If you want to remove specific toolbar actions from the main toolbar (maybe based on the current user) then you can implement this method in your extension and simply remove the actions from the provided list.

Since:

3.1-u5

getLocalizeResourceBundle

public abstract ResourceBundle getLocalizeResourceBundle(Locale locale)
                                                  throws MissingResourceException

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.

Returns:

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

Throws:

MissingResourceException - If there is no resource bundle for the given locale available.

getResourcePath

public abstract String getResourcePath()

Should return the path to the resource bundle.

Returns:

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

beforeSave

public 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.

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 )

beforeCreate

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

afterCreate

public ActionResult afterCreate(Item item,
                                DisplayState displayState,
                                Map initialValues,
                                Map values,
                                ActionResult actionResult)

Since:

2.10

afterSave

public ActionResult afterSave(Item item,
                              DisplayState displayState,
                              Map currentValues,
                              ActionResult actionResult)

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

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

actionResult - The ActionResult object, containing the status of the current action.

Returns:

ActionResult with processing informations ( action processed successful etc )

afterSave

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

beforeRemove

public ActionResult beforeRemove(Item item,
                                 ComposedType itemType,
                                 DisplayState displayState,
                                 Map values)

Parameters:

item - Item which should be removed.

displayState - DisplayState

Returns:

ActionResult with processing informations ( action processed successful etc )

Since:

2.10

afterRemove

public ActionResult afterRemove(ComposedType itemType,
                                DisplayState displayState,
                                Map values,
                                ActionResult actionResult)

Since:

2.10

notifySessionBegin

public void notifySessionBegin(DisplayState displayState,
                               JaloSession jaloSession,
                               HttpServletRequest request)

In your HMCExtension class you can implement this method to be notified of any new hmc session which is started.

Since:

2.20

adjustEditorConfiguration

public 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).

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

Since:

2.3beta