de.hybris.platform.hmc.jalo

Interface HMCContext

All Superinterfaces:

Serializable

All Known Subinterfaces:

ItemEditorContext, WizardEditorContext

All Known Implementing Classes:

GenericItemChip.GenericItemEditorContext, GenericItemChip.GenericWizardEditorContext, HMCHelper.DefaultHMCContext

public interface HMCContext
extends Serializable

HMC context to allow non-hmc code control the hmc.

Method Summary

Modifier and Type	Method and Description
boolean	canOpenWizard(String wizardType) Tells whether or not the current user is allowed to open wizards of the given type.
void	expandNode(String nodeName, boolean expanded) Expands or collapses a specified hmc explorer node.
ItemEditorContext	openItem(Item item, boolean externalEditor) Opens an item editor.
void	openType(ComposedType type) Opens the organizer associated with the given type.
void	openType(ComposedType type, Map initialAttributes) Opens the organizer associated with the given type.
void	openTypeAndSearch(ComposedType type, OrganizerSearchConfiguration cfg) Opens the organizer assoziated with the given type and directly executes a search.
void	openWizard(String wizardTypeCode) Opens a wizard inside a external window.
void	openWizard(String wizardTypeCode, Map attributes) Opens a wizard inside a external window.

Method Detail

canOpenWizard

boolean canOpenWizard(String wizardType)

Tells whether or not the current user is allowed to open wizards of the given type.

Parameters:

wizardType - the type code of the wizard item type

openItem

ItemEditorContext openItem(Item item,
                           boolean externalEditor)
                    throws JaloSecurityException

Opens an item editor. This wizard stays unchanged.

Parameters:

item - the item to edit

externalEditor - if true the item is shown in a external window

Throws:

JaloSecurityException - if the current user is not allowed to open this item

openType

void openType(ComposedType type)
       throws JaloSecurityException

Opens the organizer associated with the given type.

Parameters:

type - the type to open the organizer for

Throws:

JaloSecurityException - if the organizer could be opened e.g. if the current user is not allowed to

openType

void openType(ComposedType type,
              Map initialAttributes)
       throws JaloSecurityException

Opens the organizer associated with the given type.

Parameters:

type - the type to open the organizer for

initialAttributes - the initial attribute of the organizer creator component

Throws:

JaloSecurityException - if the organizer could be opened e.g. if the current user is not allowed to

openTypeAndSearch

void openTypeAndSearch(ComposedType type,
                       OrganizerSearchConfiguration cfg)

Opens the organizer assoziated with the given type and directly executes a search.

Parameters:

type - the type to open the organizer for

cfg - the search configuration

expandNode

void expandNode(String nodeName,
                boolean expanded)
         throws JaloInvalidParameterException,
                JaloSecurityException

Expands or collapses a specified hmc explorer node.

Parameters:

nodeName - the name of the node

expanded - if true the node will be expanded, or collapsed otherwise

Throws:

JaloInvalidParameterException - is no such node exists

JaloSecurityException - if the user is not allowed to view this node

openWizard

void openWizard(String wizardTypeCode)
         throws JaloInvalidParameterException

Opens a wizard inside a external window.

Parameters:

wizardTypeCode - the code of the wizard type

Throws:

JaloInvalidParameterException - if no such wizard exists

openWizard

void openWizard(String wizardTypeCode,
                Map attributes)
         throws JaloInvalidParameterException

Opens a wizard inside a external window.

Parameters:

wizardTypeCode - the code of the wizard type

attributes - additional attributes required by the new WizardBusinessItem instance

Throws:

JaloInvalidParameterException - if no such wizard exists