de.hybris.platform.workflow.hmc

Class CreateWorkflowWizard

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.workflow.hmc.GeneratedCreateWorkflowWizard

de.hybris.platform.workflow.hmc.CreateWorkflowWizard

All Implemented Interfaces:

JaloOnlyItem, Serializable, Comparable

public class CreateWorkflowWizard
extends GeneratedCreateWorkflowWizard

Wizard for creating an workflow instance. The wizard has to be initialized by an workflow template which will be used for workflow creation.

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 inherited from class de.hybris.platform.workflow.hmc.GeneratedCreateWorkflowWizard

ACTIONS, ATTACHMENTS, CODE, DESCRIPTION, JOB, NAME, WORKFLOW, WORKFLOWOWNER

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

Method Summary

Modifier and Type	Method and Description
List<WorkflowAction>	getActions(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.actions attribute.
Map	getAllDescription(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.description attribute.
Map	getAllName(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.name attribute.
List<WorkflowItemAttachment>	getAttachments(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.attachments attribute.
String	getCode(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.code attribute.
String	getDescription(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.description attribute.
WorkflowTemplate	getJob(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.job attribute.
String	getName(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.name attribute.
Workflow	getWorkflow(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.workflow attribute.
User	getWorkflowOwner(SessionContext ctx) Generated method - Getter of the CreateWorkflowWizard.workflowOwner attribute.
void	initialize(WizardEditorContext ctx) Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
void	initialize(WorkflowTemplate template) Initializes the wizard with given template.
void	remove() Removes this item.
void	setActions(SessionContext ctx, List<WorkflowAction> value) Generated method - Setter of the CreateWorkflowWizard.actions attribute.
void	setAllDescription(SessionContext ctx, Map value) Generated method - Setter of the CreateWorkflowWizard.description attribute.
void	setAllName(SessionContext ctx, Map value) Generated method - Setter of the CreateWorkflowWizard.name attribute.
void	setAttachments(SessionContext ctx, List<WorkflowItemAttachment> value) Generated method - Setter of the CreateWorkflowWizard.attachments attribute.
void	setDescription(SessionContext ctx, String value) Generated method - Setter of the CreateWorkflowWizard.description attribute.
void	setName(SessionContext ctx, String value) Generated method - Setter of the CreateWorkflowWizard.name attribute.
void	setWorkflow(SessionContext ctx, Workflow value) Generated method - Setter of the CreateWorkflowWizard.workflow attribute.
void	setWorkflowOwner(SessionContext ctx, User value) Generated method - Setter of the CreateWorkflowWizard.workflowOwner attribute.
void	start(WizardEditorContext ctx) Called if the user requests the wizard to start its actions.

Methods inherited from class de.hybris.platform.workflow.hmc.GeneratedCreateWorkflowWizard

getActions, getAllDescription, getAllName, getAttachments, getCode, getDescription, getJob, getName, getWorkflow, getWorkflowOwner, setActions, setAllDescription, setAllName, setAttachments, setDescription, setName, setWorkflow, setWorkflowOwner

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

Constructor Detail

CreateWorkflowWizard

public CreateWorkflowWizard()

Method Detail

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

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

getWorkflow

public Workflow getWorkflow(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.workflow attribute.

Specified by:

getWorkflow in class GeneratedCreateWorkflowWizard

Returns:

the workflow

setWorkflow

public void setWorkflow(SessionContext ctx,
                        Workflow value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.workflow attribute.

Specified by:

setWorkflow in class GeneratedCreateWorkflowWizard

value - the workflow

initialize

public void initialize(WorkflowTemplate template)

Initializes the wizard with given template. So the template will be used for essential settings.

Parameters:

template - workflow template the wizard will use for workflow creation

getActions

public List<WorkflowAction> getActions(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.actions attribute.

Specified by:

getActions in class GeneratedCreateWorkflowWizard

Returns:

the actions

getDescription

public String getDescription(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.description attribute.

Specified by:

getDescription in class GeneratedCreateWorkflowWizard

Returns:

the description

getCode

public String getCode(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.code attribute.

Specified by:

getCode in class GeneratedCreateWorkflowWizard

Returns:

the code

getName

public String getName(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.name attribute.

Specified by:

getName in class GeneratedCreateWorkflowWizard

Returns:

the name

setActions

public void setActions(SessionContext ctx,
                       List<WorkflowAction> value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.actions attribute.

Specified by:

setActions in class GeneratedCreateWorkflowWizard

value - the actions

setDescription

public void setDescription(SessionContext ctx,
                           String value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.description attribute.

Specified by:

setDescription in class GeneratedCreateWorkflowWizard

value - the description

setName

public void setName(SessionContext ctx,
                    String value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.name attribute.

Specified by:

setName in class GeneratedCreateWorkflowWizard

value - the name

getJob

public WorkflowTemplate getJob(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.job attribute.

Specified by:

getJob in class GeneratedCreateWorkflowWizard

Returns:

the job

getAttachments

public List<WorkflowItemAttachment> getAttachments(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.attachments attribute.

Specified by:

getAttachments in class GeneratedCreateWorkflowWizard

Returns:

the attachments

setAttachments

public void setAttachments(SessionContext ctx,
                           List<WorkflowItemAttachment> value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.attachments attribute.

Specified by:

setAttachments in class GeneratedCreateWorkflowWizard

value - the attachments

remove

public void remove()
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method calls Item.remove(SessionContext) with the current session's SessionContext object. See this method for more details.

Overrides:

remove in class Item

Throws:

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

getAllDescription

public Map getAllDescription(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.description attribute.

Specified by:

getAllDescription in class GeneratedCreateWorkflowWizard

Returns:

the localized description

getAllName

public Map getAllName(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.name attribute.

Specified by:

getAllName in class GeneratedCreateWorkflowWizard

Returns:

the localized name

setAllDescription

public void setAllDescription(SessionContext ctx,
                              Map value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.description attribute.

Specified by:

setAllDescription in class GeneratedCreateWorkflowWizard

value - the description

setAllName

public void setAllName(SessionContext ctx,
                       Map value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.name attribute.

Specified by:

setAllName in class GeneratedCreateWorkflowWizard

value - the name

getWorkflowOwner

public User getWorkflowOwner(SessionContext ctx)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Getter of the CreateWorkflowWizard.workflowOwner attribute.

Specified by:

getWorkflowOwner in class GeneratedCreateWorkflowWizard

Returns:

the workflowOwner

setWorkflowOwner

public void setWorkflowOwner(SessionContext ctx,
                             User value)

Description copied from class: GeneratedCreateWorkflowWizard

Generated method - Setter of the CreateWorkflowWizard.workflowOwner attribute.

Specified by:

setWorkflowOwner in class GeneratedCreateWorkflowWizard

value - the workflowOwner