de.hybris.platform.hmc.jalo

Class WizardBusinessItem

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.hmc.jalo.GeneratedWizardBusinessItem

de.hybris.platform.hmc.jalo.WizardBusinessItem

All Implemented Interfaces:

JaloOnlyItem, Serializable, Comparable

Direct Known Subclasses:

GeneratedBMECatExportWizard, GeneratedBMECatImportWithCsvWizard, GeneratedBMECatImportWizard, GeneratedCompareCatalogVersionWizard, GeneratedCreateChapterPreviewWizard, GeneratedCreatePagePreviewWizard, GeneratedCreatePublicationPreviewWizard, GeneratedCreateWorkflowWizard, GeneratedGenericDataSupplierGenerationWizard, GeneratedImpExExportWizard, GeneratedImpExImportWizard, GeneratedImportCometConfigurationWizard, GeneratedImportExportUserRightsWizard, GeneratedLDIFGroupImportWizard, GeneratedLDIFImportWizard, GeneratedMoveMediaWizard, GeneratedRemoveCatalogWizard, GeneratedRemoveItemsWizard, GeneratedRepairProcessWizard, GeneratedSampleWizard, GeneratedScriptGeneratorWizard, GeneratedSolrIndexerHotUpdateWizard, GeneratedSolrIndexerOperationWizard, GeneratedSynchronizeCatalogVersionWizard

public abstract class WizardBusinessItem
extends GeneratedWizardBusinessItem
implements JaloOnlyItem

The base class of all hmc wizards.

Version:

ExtGen v1.3

See Also:

Serialized Form

Nested Class Summary

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

LocalizableItem.LocalizableItemImpl

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

ExtensibleItem.ExtensibleItemImpl

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

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACK_BUTTON
static String	BACK_BUTTON_NAME
static String	CANCEL_BUTTON
static String	CANCEL_BUTTON_NAME
static String	CLOSE_BUTTON_NAME
static String	DONE_BUTTON_NAME
static String	NEXT_BUTTON
static String	NEXT_BUTTON_NAME
static String	START_BUTTON
static String	START_BUTTON_NAME

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
WizardBusinessItem()

Method Summary

Modifier and Type	Method and Description
void	abortProcessing(WizardEditorContext ctx) Called if the current wizard process should be aborted. Note: The default implementation will always throw a VetoException to signal that an abortion of the wizard process is not possible.
protected void	appendLocalizedTemplateString(StringBuilder stringBuilder, String key, Map values) Retrieves a localized string which may contain placeholders like {key} which are replaced by the values provided as map.
void	close(WizardEditorContext ctx) Called if the wizard window is going to be closed.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Returns a new wizard instance.
Object	doGetAttribute(SessionContext ctx, String attrQualifier) Implements in-memory attributes backed by a Map.
void	doSetAttribute(SessionContext ctx, String attrQualifier, Object value) Implements in-memory attributes backed by a Map.
protected void	endProcessing(WizardEditorContext ctx) Convenience method to end the wizard's processing mode.
protected String	getLocalizedTemplateString(String key, Map values) Retrieves a localized string which may contain placeholders like {key} which are replaced by the values provided as map.
void	initialize(WizardEditorContext ctx) Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
boolean	isCloseAllowed() This method returns the value if a wizard can be closed per X in the upper right of the wizardwindow.
void	pollStatus(WizardEditorContext ctx) Called during processing mode every time the wizards refreshes its status information.
ComposedType	provideComposedType() Should provide the composed type of this item.
Date	provideCreationTime() Should provide a fixed creation time for this item.
Date	provideModificationTime() Should provide a modification time for this item.
PK	providePK() Should provide a fixed PK for this item.
void	removeJaloOnly() Called when a jalo only item is removed.
void	setClosedAllowed(boolean value) This method changes the closing behavior of a wizard windows. Set it to true if the wizardwindow can be closed by the upper right X. Set it to false if the wizardwindow can not be closed by the upper right X. As default the value is set to true.
void	start(WizardEditorContext ctx) Called if the user requests the wizard to start its actions.
protected void	startProcessing(WizardEditorContext ctx) Convenience method to start the wizard's processing mode.
void	tabChanges(WizardEditorContext ctx, String fromTabName, String toTabName) Called before the current tab is changed.
void	validate(WizardEditorContext ctx) Deprecated. override validate(WizardEditorContext, String, String) instead
void	validate(WizardEditorContext ctx, String fromTab, String toTab) Called before tab is changed start event delivered or if validation was explicitely requested.

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

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

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

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

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getNonInitialAttributes, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CANCEL_BUTTON

public static final String CANCEL_BUTTON

See Also:

Constant Field Values

NEXT_BUTTON

public static final String NEXT_BUTTON

See Also:

Constant Field Values

BACK_BUTTON

public static final String BACK_BUTTON

See Also:

Constant Field Values

START_BUTTON

public static final String START_BUTTON

See Also:

Constant Field Values

CANCEL_BUTTON_NAME

public static final String CANCEL_BUTTON_NAME

See Also:

Constant Field Values

NEXT_BUTTON_NAME

public static final String NEXT_BUTTON_NAME

See Also:

Constant Field Values

BACK_BUTTON_NAME

public static final String BACK_BUTTON_NAME

See Also:

Constant Field Values

START_BUTTON_NAME

public static final String START_BUTTON_NAME

See Also:

Constant Field Values

DONE_BUTTON_NAME

public static final String DONE_BUTTON_NAME

See Also:

Constant Field Values

CLOSE_BUTTON_NAME

public static final String CLOSE_BUTTON_NAME

See Also:

Constant Field Values

Constructor Detail

WizardBusinessItem

public WizardBusinessItem()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Returns a new wizard instance.

Specified by:

createItem in class Item

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

provideComposedType

public final ComposedType provideComposedType()

Description copied from interface: JaloOnlyItem

Should provide the composed type of this item.

Specified by:

provideComposedType in interface JaloOnlyItem

Returns:

ComposedType of this item

provideCreationTime

public final Date provideCreationTime()

Description copied from interface: JaloOnlyItem

Should provide a fixed creation time for this item.

Specified by:

provideCreationTime in interface JaloOnlyItem

Returns:

creation time date of this item

provideModificationTime

public final Date provideModificationTime()

Description copied from interface: JaloOnlyItem

Should provide a modification time for this item.

Specified by:

provideModificationTime in interface JaloOnlyItem

Returns:

modification time date of this item

providePK

public final PK providePK()

Description copied from interface: JaloOnlyItem

Should provide a fixed PK for this item.

Specified by:

providePK in interface JaloOnlyItem

Returns:

PK of this item

removeJaloOnly

public void removeJaloOnly()
                    throws ConsistencyCheckException

Description copied from interface: JaloOnlyItem

Called when a jalo only item is removed. This is the place to do any cleanup if necessary.

Specified by:

removeJaloOnly in interface JaloOnlyItem

Throws:

ConsistencyCheckException - to signal that this item removal failed

doGetAttribute

public Object doGetAttribute(SessionContext ctx,
                             String attrQualifier)
                      throws JaloInvalidParameterException,
                             JaloSecurityException

Implements in-memory attributes backed by a Map.

Specified by:

doGetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

attrQualifier - the qualifier of the requested attribute

Returns:

the attribute value

Throws:

JaloInvalidParameterException - in case no value could be read for this attribute

JaloSecurityException

doSetAttribute

public void doSetAttribute(SessionContext ctx,
                           String attrQualifier,
                           Object value)
                    throws JaloInvalidParameterException,
                           JaloSecurityException,
                           JaloBusinessException

Implements in-memory attributes backed by a Map.

Specified by:

doSetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

attrQualifier - the qualifier of the requested attribute

value - the new attribute value

Throws:

JaloInvalidParameterException - in case the value could not be written for this attribute

JaloSecurityException - in case the session user is not allowed to write this attribute

JaloBusinessException - in case any other error occured

initialize

public void initialize(WizardEditorContext ctx)

Called to initialize the wizard immediately after the item editor creates the WizardEditorContext. Default implementation does nothing, you should override this method and implement appropriate init steps.

Parameters:

ctx - the wizard editor context

validate

@Deprecated
public void validate(WizardEditorContext ctx)
                          throws ValidationException

Deprecated. override validate(WizardEditorContext, String, String) instead

Called before

• tab is changed
• start event delivered
• or if validation was explicitely requested.

To check current input values use ItemEditorContext.getCurrentValue(String).

To signal an error a ValidationException must be raised. The actual event (tab change or start of this wizard) is not executed in this case but a error popup is shown.

Additionally erroneous fields may be marked via ItemEditorContext.showError(String, String).

Parameters:

ctx - the wizard editor context

Throws:

ValidationException

validate

public void validate(WizardEditorContext ctx,
                     String fromTab,
                     String toTab)
              throws ValidationException

Called before

• tab is changed
• start event delivered
• or if validation was explicitely requested.

To check current input values use ItemEditorContext.getCurrentValue(String).

To signal an error a ValidationException must be raised. The actual event (tab change or start of this wizard) is not executed in this case but a error popup is shown.

Additionally erroneous fields may be marked via ItemEditorContext.showError(String, String).

Make sure that always super.validate is called !

Parameters:

ctx - the wizard editor context

fromTab - the tab which is being left

toTab - the new target tab

Throws:

ValidationException

Since:

2.10

tabChanges

public void tabChanges(WizardEditorContext ctx,
                       String fromTabName,
                       String toTabName)
                throws VetoException

Called before the current tab is changed. If the current state should not allow the tab change a VetoException must be raised. In this case a error popup is shown.

Parameters:

ctx - the wizard editor context

fromTabName - the current tab name

toTabName - the new tab name

Throws:

VetoException - to signal the tab cannot be changed right now

start

public void start(WizardEditorContext ctx)
           throws VetoException

Called if the user requests the wizard to start its actions. Validation is already done when this method is called.

Parameters:

ctx - the wizard editor context

Throws:

VetoException - to signal that the wizard cannot be started right now

close

public void close(WizardEditorContext ctx)
           throws VetoException

Called if the wizard window is going to be closed.

Parameters:

ctx - the wizard editor context

Throws:

VetoException - to signal that the window cannot be closed right now.

abortProcessing

public void abortProcessing(WizardEditorContext ctx)
                     throws VetoException

Called if the current wizard process should be aborted.
Note: The default implementation will always throw a VetoException to signal that an abortion of the wizard process is not possible. You would have to implement your own abortProcessing() method to deal with the abortion. If your wizard process cannot or should not be aborted, just don't offer the 'cancel' option while processing (this is the default behaviour when using startProcessing(WizardEditorContext) and endProcessing(WizardEditorContext)).!

Parameters:

ctx - the wizard editor context

Throws:

VetoException - to signal that the process cannot be aborted right now.

startProcessing

protected void startProcessing(WizardEditorContext ctx)

Convenience method to start the wizard's processing mode.
The processing mode will be set to true and the wizard buttons will all be hidden. To reverse this, call endProcessing(WizardEditorContext).

Parameters:

ctx - the wizard editor context

endProcessing

protected void endProcessing(WizardEditorContext ctx)

Convenience method to end the wizard's processing mode.
The processing mode will be set to false and the wizard buttons will all be shown again.

Parameters:

ctx - the wizard editor context

See Also:

startProcessing(WizardEditorContext)

pollStatus

public void pollStatus(WizardEditorContext ctx)

Called during processing mode every time the wizards refreshes its status information. Use WizardEditorContext.setStatus(String, int, boolean) to update the displayed status.

The method is called before the wizard is rendered. So changing the procesing mode here is allowed.

Parameters:

ctx - the wizard editor context

getLocalizedTemplateString

protected String getLocalizedTemplateString(String key,
                                            Map values)
                                     throws JaloInvalidParameterException

Retrieves a localized string which may contain placeholders like {key} which are replaced by the values provided as map.

Parameters:

key - the key of the localized template string

values - the placeholder values to fill in

Returns:

the translated string

Throws:

JaloInvalidParameterException - if a placeholder value is missing

appendLocalizedTemplateString

protected void appendLocalizedTemplateString(StringBuilder stringBuilder,
                                             String key,
                                             Map values)
                                      throws JaloInvalidParameterException

Retrieves a localized string which may contain placeholders like {key} which are replaced by the values provided as map. The translated string is appended to the given string buffer.

Parameters:

stringBuilder - the string buffer to append to

key - the key of the localized template string

values - the placeholder values to fill in

Throws:

JaloInvalidParameterException - if a placeholder value is missing

isCloseAllowed

public boolean isCloseAllowed()

This method returns the value if a wizard can be closed per X in the upper right of the wizardwindow. As default this method returns true so the window can be closed with the upper right X.

Returns:

if the wizard can be closed with the upper right X or not

setClosedAllowed

public void setClosedAllowed(boolean value)

This method changes the closing behavior of a wizard windows.
Set it to true if the wizardwindow can be closed by the upper right X.
Set it to false if the wizardwindow can not be closed by the upper right X.
As default the value is set to true.

Parameters:

value - a boolean value which allows to close the wizzard window with the upper right X.