de.hybris.platform.workflow.hmc

Class WorkflowHMCExtension

java.lang.Object

de.hybris.platform.hmc.extension.HMCExtension

de.hybris.platform.workflow.hmc.WorkflowHMCExtension

public class WorkflowHMCExtension
extends HMCExtension

Provides necessary meta information about the workflow hmc extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_CREATE
static String	ACTION_REMOVE
static String	ACTION_SAVE
static String	RESOURCE_PATH Identifier of property defining path to resource bundles.

Constructor Summary

Constructors

Constructor and Description
WorkflowHMCExtension()

Method Summary

Modifier and Type	Method and Description
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, Map initialValues, ActionResult actionResult)
ActionResult	beforeCreate(ComposedType itemType, DisplayState displayState, Map initialValues)
List	getEditorTabChips(DisplayState displayState, AbstractEditorMenuChip parent)
static String	getLocalizedString(String strKey, SessionContext ctx) Returns a localized string for the given key.
static String	getLocalizedString(String strKey, String isocode) Returns a localized string for the given key.
static ResourceBundle	getLocalizeResBundle(String isoCode) Returns the resource bundle for the given iso code.
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

adjustEditorConfiguration, adjustToolbarActionChips, afterSave, beforeRemove, beforeSave, 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

Identifier of property defining path to resource bundles.

See Also:

Constant Field Values

ACTION_CREATE

public static final String ACTION_CREATE

See Also:

Constant Field Values

ACTION_REMOVE

public static final String ACTION_REMOVE

See Also:

Constant Field Values

ACTION_SAVE

public static final String ACTION_SAVE

See Also:

Constant Field Values

Constructor Detail

WorkflowHMCExtension

public WorkflowHMCExtension()

Method Detail

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.

getLocalizeResBundle

public static ResourceBundle getLocalizeResBundle(String isoCode)
                                           throws MissingResourceException

Returns the resource bundle for the given iso code. Uses RESOURCE_PATH to locate the resource bundle.

Parameters:

isoCode - the resource bundle iso code.

Returns:

ResourceBundle the resource bundle

Throws:

MissingResourceException - if the resource bundle is missing at the given path

getLocalizedString

public static String getLocalizedString(String strKey,
                                        String isocode)

Returns a localized string for the given key. If the key doesn't exists the key itself will be returned.

Parameters:

strKey - the localized string key

isocode - the language iso code.

Returns:

localized string for given key

getLocalizedString

public static String getLocalizedString(String strKey,
                                        SessionContext ctx)

Returns a localized string for the given key. If the key doesn't exists the key itself will be returned.

Parameters:

strKey - the localized string key.

ctx - the current session context. Will be used to compute the isocode of the session context language.

Returns:

localized string for given key

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.

afterSave

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

Overrides:

afterSave in class HMCExtension

afterCreate

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

Overrides:

afterCreate in class HMCExtension

afterRemove

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

Overrides:

afterRemove in class HMCExtension

beforeCreate

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

Overrides:

beforeCreate in class HMCExtension