de.hybris.platform.impex.jalo.cronjob

Class ScriptGeneratorWizard

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.impex.jalo.cronjob.GeneratedScriptGeneratorWizard

de.hybris.platform.impex.jalo.cronjob.ScriptGeneratorWizard

All Implemented Interfaces:

ScriptProcessingWizard, JaloOnlyItem, Serializable, Comparable

public class ScriptGeneratorWizard
extends GeneratedScriptGeneratorWizard
implements ScriptProcessingWizard

Wizard which offers support for the generation of HeaderLibraries and ImpEx based export scripts.

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
protected WizardEditorContext	wizardCtx

Fields inherited from class de.hybris.platform.impex.jalo.cronjob.GeneratedScriptGeneratorWizard

IMPEXSCRIPT, INCLUDESYSTEMTYPES, LANGUAGES, MODE, MODIFIER, SCRIPT, USEDOCUMENTID

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
ScriptGeneratorWizard()

Method Summary

Modifier and Type	Method and Description
static EnumerationValue	DEFAULTMODIFIER()
static EnumerationValue	EXPORTMODE()
String	getGeneratedScript() Deprecated. use GeneratedScriptGeneratorWizard.getImpExScript() instead
String	getImpExScript(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.impExScript attribute.
ImpExMedia	getJobMedia()
Set<Language>	getLanguages(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.languages attribute.
String	getMediaCode(String prefix)
EnumerationValue	getMode(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.mode attribute.
EnumerationValue	getModifier(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.modifier attribute.
ImpExMedia	getScript(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.script attribute.
ScriptModifier	getScriptModifier()
static EnumerationValue	HEADERMODE()
void	initialize(WizardEditorContext ctx) Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
protected void	initializeTabs(WizardEditorContext ctx)
boolean	isExportScriptMode()
boolean	isHeaderMode()
Boolean	isIncludeSystemTypes(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.includeSystemTypes attribute.
Boolean	isUseDocumentID(SessionContext ctx) Generated method - Getter of the ScriptGeneratorWizard.useDocumentID attribute.
void	reloadField(String field)
void	reloadScript(SessionContext ctx, ImpExMedia media)
void	setExportTemplate(SessionContext ctx, HeaderLibrary param) Deprecated. use ScriptGenerator#setHeaderLibrary( SessionContext ctx, HeaderLibrary param )
void	setGeneratedScript(SessionContext ctx, String value) Deprecated. use setImpExScript(de.hybris.platform.jalo.SessionContext, java.lang.String) instead
void	setHeaderLibrary(SessionContext ctx, HeaderLibrary param) empty implementation
void	setImpExScript(SessionContext ctx, String value) Generated method - Setter of the ScriptGeneratorWizard.impExScript attribute.
void	setIncludeSystemTypes(SessionContext ctx, Boolean value) Generated method - Setter of the ScriptGeneratorWizard.includeSystemTypes attribute.
void	setJobMedia(ImpExMedia value)
void	setLanguages(SessionContext ctx, Set<Language> value) Generated method - Setter of the ScriptGeneratorWizard.languages attribute.
void	setMode(SessionContext ctx, EnumerationValue value) Generated method - Setter of the ScriptGeneratorWizard.mode attribute.
void	setModifier(SessionContext ctx, EnumerationValue value) Generated method - Setter of the ScriptGeneratorWizard.modifier attribute.
void	setScript(SessionContext ctx, ImpExMedia media) Generated method - Setter of the ScriptGeneratorWizard.script attribute.
void	setUseDocumentID(SessionContext ctx, Boolean value) Generated method - Setter of the ScriptGeneratorWizard.useDocumentID attribute.

Methods inherited from class de.hybris.platform.impex.jalo.cronjob.GeneratedScriptGeneratorWizard

getImpExScript, getLanguages, getMode, getModifier, getScript, isIncludeSystemTypes, isIncludeSystemTypesAsPrimitive, isIncludeSystemTypesAsPrimitive, isUseDocumentID, isUseDocumentIDAsPrimitive, isUseDocumentIDAsPrimitive, setImpExScript, setIncludeSystemTypes, setIncludeSystemTypes, setIncludeSystemTypes, setLanguages, setMode, setModifier, setScript, setUseDocumentID, setUseDocumentID, setUseDocumentID

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

abortProcessing, appendLocalizedTemplateString, close, createItem, doGetAttribute, doSetAttribute, endProcessing, getLocalizedTemplateString, isCloseAllowed, pollStatus, provideComposedType, provideCreationTime, provideModificationTime, providePK, removeJaloOnly, setClosedAllowed, start, startProcessing, tabChanges, validate, 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, 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

Methods inherited from interface de.hybris.platform.impex.jalo.cronjob.ScriptProcessingWizard

getImpExScript, getMode

Field Detail

wizardCtx

protected WizardEditorContext wizardCtx

Constructor Detail

ScriptGeneratorWizard

public ScriptGeneratorWizard()

Method Detail

EXPORTMODE

public static EnumerationValue EXPORTMODE()

HEADERMODE

public static EnumerationValue HEADERMODE()

DEFAULTMODIFIER

public static EnumerationValue DEFAULTMODIFIER()

initialize

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

initializeTabs

protected void initializeTabs(WizardEditorContext ctx)

Parameters:

ctx -

getJobMedia

public ImpExMedia getJobMedia()

Specified by:

getJobMedia in interface ScriptProcessingWizard

Returns:

the assigned 'export script' media

setJobMedia

public void setJobMedia(ImpExMedia value)

Specified by:

setJobMedia in interface ScriptProcessingWizard

isUseDocumentID

public Boolean isUseDocumentID(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.useDocumentID attribute.

Specified by:

isUseDocumentID in class GeneratedScriptGeneratorWizard

Returns:

the useDocumentID

setUseDocumentID

public void setUseDocumentID(SessionContext ctx,
                             Boolean value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.useDocumentID attribute.

Specified by:

setUseDocumentID in class GeneratedScriptGeneratorWizard

value - the useDocumentID

isIncludeSystemTypes

public Boolean isIncludeSystemTypes(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.includeSystemTypes attribute.

Specified by:

isIncludeSystemTypes in class GeneratedScriptGeneratorWizard

Returns:

the includeSystemTypes

setIncludeSystemTypes

public void setIncludeSystemTypes(SessionContext ctx,
                                  Boolean value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.includeSystemTypes attribute.

Specified by:

setIncludeSystemTypes in class GeneratedScriptGeneratorWizard

value - the includeSystemTypes

isExportScriptMode

public boolean isExportScriptMode()

Returns:

export script mode?

isHeaderMode

public boolean isHeaderMode()

Returns:

header generation mode?

setImpExScript

public void setImpExScript(SessionContext ctx,
                           String value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.impExScript attribute.

Specified by:

setImpExScript in class GeneratedScriptGeneratorWizard

value - the impExScript

setGeneratedScript

@Deprecated
public void setGeneratedScript(SessionContext ctx,
                                           String value)

Deprecated. use setImpExScript(de.hybris.platform.jalo.SessionContext, java.lang.String) instead

setMode

public void setMode(SessionContext ctx,
                    EnumerationValue value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.mode attribute.

Specified by:

setMode in class GeneratedScriptGeneratorWizard

value - the mode

setModifier

public void setModifier(SessionContext ctx,
                        EnumerationValue value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.modifier attribute.

Specified by:

setModifier in class GeneratedScriptGeneratorWizard

value - the modifier

setScript

public void setScript(SessionContext ctx,
                      ImpExMedia media)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.script attribute.

Specified by:

setScript in class GeneratedScriptGeneratorWizard

media - the script

getImpExScript

public String getImpExScript(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.impExScript attribute.

Specified by:

getImpExScript in class GeneratedScriptGeneratorWizard

Returns:

the impExScript

getGeneratedScript

@Deprecated
public String getGeneratedScript()

Deprecated. use GeneratedScriptGeneratorWizard.getImpExScript() instead

getMode

public EnumerationValue getMode(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.mode attribute.

Specified by:

getMode in class GeneratedScriptGeneratorWizard

Returns:

the mode

getModifier

public EnumerationValue getModifier(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.modifier attribute.

Specified by:

getModifier in class GeneratedScriptGeneratorWizard

Returns:

the modifier

getScript

public ImpExMedia getScript(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.script attribute.

Specified by:

getScript in class GeneratedScriptGeneratorWizard

Returns:

the script

getMediaCode

public String getMediaCode(String prefix)

Specified by:

getMediaCode in interface ScriptProcessingWizard

Returns:

generated mediacode

getScriptModifier

public ScriptModifier getScriptModifier()
                                 throws VetoException

Returns:

the used implementation of ScriptModifier

Throws:

VetoException

reloadScript

public void reloadScript(SessionContext ctx,
                         ImpExMedia media)

Specified by:

reloadScript in interface ScriptProcessingWizard

reloadField

public void reloadField(String field)

Parameters:

field -

setExportTemplate

@Deprecated
public void setExportTemplate(SessionContext ctx,
                                          HeaderLibrary param)

Deprecated. use ScriptGenerator#setHeaderLibrary( SessionContext ctx, HeaderLibrary param )

setHeaderLibrary

public void setHeaderLibrary(SessionContext ctx,
                             HeaderLibrary param)

empty implementation

Specified by:

setHeaderLibrary in interface ScriptProcessingWizard

getLanguages

public Set<Language> getLanguages(SessionContext ctx)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Getter of the ScriptGeneratorWizard.languages attribute.

Specified by:

getLanguages in class GeneratedScriptGeneratorWizard

Returns:

the languages

setLanguages

public void setLanguages(SessionContext ctx,
                         Set<Language> value)

Description copied from class: GeneratedScriptGeneratorWizard

Generated method - Setter of the ScriptGeneratorWizard.languages attribute.

Specified by:

setLanguages in class GeneratedScriptGeneratorWizard

value - the languages