de.hybris.platform.catalog.hmc

Class SynchronizeCatalogVersionWizard

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

de.hybris.platform.catalog.hmc.GeneratedSynchronizeCatalogVersionWizard

de.hybris.platform.catalog.hmc.SynchronizeCatalogVersionWizard

All Implemented Interfaces:

JaloOnlyItem, Serializable, Comparable

public class SynchronizeCatalogVersionWizard
extends GeneratedSynchronizeCatalogVersionWizard

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SynchronizeCatalogVersionWizard.AbstractTab
protected class	SynchronizeCatalogVersionWizard.DoSyncProcessor Synchronization processor.
protected class	SynchronizeCatalogVersionWizard.FullSyncConfigurator
protected static interface	SynchronizeCatalogVersionWizard.ItemSelectionTab
protected static interface	SynchronizeCatalogVersionWizard.JobProviderTab
protected class	SynchronizeCatalogVersionWizard.ManualItemsSelectionTab
protected class	SynchronizeCatalogVersionWizard.SelectedItemsSyncConfigurator
protected class	SynchronizeCatalogVersionWizard.SourceVersionTab Tab 1: Source version selection: todo
protected static interface	SynchronizeCatalogVersionWizard.SyncWizardProcessor
protected static interface	SynchronizeCatalogVersionWizard.SyncWizardTab
protected class	SynchronizeCatalogVersionWizard.TargetVersionTab Tab 6: Target version selection: todo

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	TAB_SUMMARY
static String	TAB1
static String	TAB2
static String	TAB3
static String	TAB4
static String	TAB5
static String	TAB6
static String	TAB7

Fields inherited from class de.hybris.platform.catalog.hmc.GeneratedSynchronizeCatalogVersionWizard

CATEGORIES, CREATESAVEDVALUES, CRONJOBS, EXECUTABLEJOBS, FORCEUPDATE, IGNOREERRORS, INCLUDINGPRODUCTS, INCLUDINGSUBCATEGORIES, KEEPCRONJOB, KEYWORDS, LOGLEVELDATABASE, LOGLEVELFILE, LOGTODATABASE, LOGTOFILE, MEDIAS, OTHERS, PRESETITEMS, PRODUCTS, SOURCEVERSIONS

Fields inherited from class de.hybris.platform.hmc.jalo.WizardBusinessItem

BACK_BUTTON, BACK_BUTTON_NAME, CANCEL_BUTTON, CANCEL_BUTTON_NAME, CLOSE_BUTTON_NAME, DONE_BUTTON_NAME, NEXT_BUTTON, NEXT_BUTTON_NAME, START_BUTTON, 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
SynchronizeCatalogVersionWizard()

Method Summary

Modifier and Type	Method and Description
void	close(WizardEditorContext ctx) Called if the wizard window is going to be closed.
protected Collection<Item>	collectItemsForJob(SyncItemJob job)
protected SynchronizeCatalogVersionWizard.SyncWizardTab	createTabs(WizardEditorContext ctx)
protected String	dispatchPresetItems(WizardEditorContext ctx, Collection<Item> items)
protected List	filterItemsForJob(SyncItemJob job, Collection<Item> items)
protected Collection<CatalogVersion>	filterSynchronizableCatalogVersions(Collection<CatalogVersion> sourceCatalogVersions) This method cycles throught the given source CatalogVersions and check for each source if the current user can read this source CatalogVersion.
protected Collection<CatalogVersion>	getAllPossibleSourceVersions(SessionContext ctx)
Collection	getCronJobs(SessionContext ctx) Generated method - Getter of the SynchronizeCatalogVersionWizard.cronJobs attribute.
protected SynchronizeCatalogVersionWizard.SyncWizardProcessor	getCurrentProcessor()
List<SyncItemJob>	getExecutableJobs(SessionContext ctx) Dynamically calculating executable jobs based upon tabs which may provide jobs or not ( see SynchronizeCatalogVersionWizard.JobProviderTab ).
protected Set	getJobsForItems(Collection<Item> items)
protected Set	getJobsForSourceVersions(Collection<CatalogVersion> versions)
Collection	getSourceVersions(SessionContext ctx) Generated method - Getter of the SynchronizeCatalogVersionWizard.sourceVersions attribute.
protected SynchronizeCatalogVersionWizard.SyncWizardTab	getTab(String tabID)
protected List<SynchronizeCatalogVersionWizard.SyncWizardTab>	getTabList()
protected Set	getTargetVersionsForJobs(Collection<SyncItemJob> jobs)
protected boolean	hasRunningCronjobs()
void	initialize(WizardEditorContext ctx) Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
void	pollStatus(WizardEditorContext ctx) Called during processing mode every time the wizards refreshes its status information.
void	remove(SessionContext ctx) Removes the wizard instance along with its cronjob if it already exists.
protected void	removeCronjobs(SessionContext ctx)
protected Collection<Category>	selectCategories(Collection<Item> items)
protected void	setCurrentProcessor(SynchronizeCatalogVersionWizard.SyncWizardProcessor syncWizzProc)
void	start(WizardEditorContext ctx) Called if the user requests the wizard to start its actions.
protected void	stopCronjobs(SessionContext ctx)
void	tabChanges(WizardEditorContext ctx, String fromTabName, String toTabName) Called before the current tab is changed.
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.catalog.hmc.GeneratedSynchronizeCatalogVersionWizard

getCategories, getCategories, getCronJobs, getExecutableJobs, getKeywords, getKeywords, getLogLevelDatabase, getLogLevelDatabase, getLogLevelFile, getLogLevelFile, getMedias, getMedias, getOthers, getOthers, getProducts, getProducts, getSourceVersions, isCreateSavedValues, isCreateSavedValues, isCreateSavedValuesAsPrimitive, isCreateSavedValuesAsPrimitive, isForceUpdate, isForceUpdate, isForceUpdateAsPrimitive, isForceUpdateAsPrimitive, isIgnoreErrors, isIgnoreErrors, isIgnoreErrorsAsPrimitive, isIgnoreErrorsAsPrimitive, isIncludingProducts, isIncludingProducts, isIncludingProductsAsPrimitive, isIncludingProductsAsPrimitive, isIncludingSubcategories, isIncludingSubcategories, isIncludingSubcategoriesAsPrimitive, isIncludingSubcategoriesAsPrimitive, isKeepCronJob, isKeepCronJob, isKeepCronJobAsPrimitive, isKeepCronJobAsPrimitive, isLogToDatabase, isLogToDatabase, isLogToDatabaseAsPrimitive, isLogToDatabaseAsPrimitive, isLogToFile, isLogToFile, isLogToFileAsPrimitive, isLogToFileAsPrimitive, setCategories, setCategories, setCreateSavedValues, setCreateSavedValues, setCreateSavedValues, setCreateSavedValues, setForceUpdate, setForceUpdate, setForceUpdate, setForceUpdate, setIgnoreErrors, setIgnoreErrors, setIgnoreErrors, setIgnoreErrors, setIncludingProducts, setIncludingProducts, setIncludingProducts, setIncludingProducts, setIncludingSubcategories, setIncludingSubcategories, setIncludingSubcategories, setIncludingSubcategories, setKeepCronJob, setKeepCronJob, setKeepCronJob, setKeepCronJob, setKeywords, setKeywords, setLogLevelDatabase, setLogLevelDatabase, setLogLevelFile, setLogLevelFile, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToFile, setLogToFile, setLogToFile, setLogToFile, setMedias, setMedias, setOthers, setOthers, setProducts, setProducts, setSourceVersions, setSourceVersions

Methods inherited from class de.hybris.platform.hmc.jalo.WizardBusinessItem

abortProcessing, appendLocalizedTemplateString, createItem, doGetAttribute, doSetAttribute, endProcessing, getLocalizedTemplateString, isCloseAllowed, provideComposedType, provideCreationTime, provideModificationTime, providePK, removeJaloOnly, setClosedAllowed, startProcessing, validate

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, 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

TAB1

public static final String TAB1

See Also:

Constant Field Values

TAB2

public static final String TAB2

See Also:

Constant Field Values

TAB3

public static final String TAB3

See Also:

Constant Field Values

TAB4

public static final String TAB4

See Also:

Constant Field Values

TAB5

public static final String TAB5

See Also:

Constant Field Values

TAB6

public static final String TAB6

See Also:

Constant Field Values

TAB7

public static final String TAB7

See Also:

Constant Field Values

TAB_SUMMARY

public static final String TAB_SUMMARY

See Also:

Constant Field Values

Constructor Detail

SynchronizeCatalogVersionWizard

public SynchronizeCatalogVersionWizard()

Method Detail

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Removes the wizard instance along with its cronjob if it already exists. In case the cronjob is currently running the wizard will try to abort the cronjob and

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

hasRunningCronjobs

protected boolean hasRunningCronjobs()

stopCronjobs

protected void stopCronjobs(SessionContext ctx)

removeCronjobs

protected void removeCronjobs(SessionContext ctx)

getTabList

protected List<SynchronizeCatalogVersionWizard.SyncWizardTab> getTabList()

createTabs

protected SynchronizeCatalogVersionWizard.SyncWizardTab createTabs(WizardEditorContext ctx)

getTab

protected SynchronizeCatalogVersionWizard.SyncWizardTab getTab(String tabID)

getCurrentProcessor

protected SynchronizeCatalogVersionWizard.SyncWizardProcessor getCurrentProcessor()

setCurrentProcessor

protected void setCurrentProcessor(SynchronizeCatalogVersionWizard.SyncWizardProcessor syncWizzProc)

filterSynchronizableCatalogVersions

protected Collection<CatalogVersion> filterSynchronizableCatalogVersions(Collection<CatalogVersion> sourceCatalogVersions)

This method cycles throught the given source CatalogVersions and check for each source if the current user can read this source CatalogVersion. After this it is checked if at least one writable catalogVersion for the given sync rules is given. The returned collection contains all source catalogversions where this applies.

initialize

public void initialize(WizardEditorContext ctx)

Description copied from class: WizardBusinessItem

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.

Overrides:

initialize in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

validate

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

Description copied from class: WizardBusinessItem

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 !

Overrides:

validate in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

fromTab - the tab which is being left

toTab - the new target tab

Throws:

ValidationException

close

public void close(WizardEditorContext ctx)
           throws VetoException

Description copied from class: WizardBusinessItem

Called if the wizard window is going to be closed.

Overrides:

close in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

Throws:

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

start

public void start(WizardEditorContext ctx)
           throws VetoException

Description copied from class: WizardBusinessItem

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

Overrides:

start in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

Throws:

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

tabChanges

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

Description copied from class: WizardBusinessItem

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.

Overrides:

tabChanges in class WizardBusinessItem

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

pollStatus

public void pollStatus(WizardEditorContext ctx)

Description copied from class: WizardBusinessItem

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.

Overrides:

pollStatus in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

filterItemsForJob

protected List filterItemsForJob(SyncItemJob job,
                                 Collection<Item> items)

getJobsForItems

protected Set getJobsForItems(Collection<Item> items)

getJobsForSourceVersions

protected Set getJobsForSourceVersions(Collection<CatalogVersion> versions)

getTargetVersionsForJobs

protected Set getTargetVersionsForJobs(Collection<SyncItemJob> jobs)

selectCategories

protected Collection<Category> selectCategories(Collection<Item> items)

collectItemsForJob

protected Collection<Item> collectItemsForJob(SyncItemJob job)

dispatchPresetItems

protected String dispatchPresetItems(WizardEditorContext ctx,
                                     Collection<Item> items)

getExecutableJobs

public List<SyncItemJob> getExecutableJobs(SessionContext ctx)

Dynamically calculating executable jobs based upon tabs which may provide jobs or not ( see SynchronizeCatalogVersionWizard.JobProviderTab ).

Overrides:

getExecutableJobs in class GeneratedSynchronizeCatalogVersionWizard

Returns:

the executableJobs

getSourceVersions

public Collection getSourceVersions(SessionContext ctx)

Description copied from class: GeneratedSynchronizeCatalogVersionWizard

Generated method - Getter of the SynchronizeCatalogVersionWizard.sourceVersions attribute.

Overrides:

getSourceVersions in class GeneratedSynchronizeCatalogVersionWizard

Returns:

the sourceVersions

getAllPossibleSourceVersions

protected Collection<CatalogVersion> getAllPossibleSourceVersions(SessionContext ctx)

getCronJobs

public Collection getCronJobs(SessionContext ctx)

Description copied from class: GeneratedSynchronizeCatalogVersionWizard

Generated method - Getter of the SynchronizeCatalogVersionWizard.cronJobs attribute.

Specified by:

getCronJobs in class GeneratedSynchronizeCatalogVersionWizard

Returns:

the cronJobs