Package de.hybris.platform.workflow.jalo

Class WorkflowActionTemplate

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.jalo.GenericItem

de.hybris.platform.workflow.jalo.GeneratedAbstractWorkflowAction

de.hybris.platform.workflow.jalo.AbstractWorkflowAction

de.hybris.platform.workflow.jalo.GeneratedWorkflowActionTemplate

de.hybris.platform.workflow.jalo.WorkflowActionTemplate

All Implemented Interfaces:

RequirementHolder, Serializable, Comparable

Direct Known Subclasses:

GeneratedAutomatedWorkflowActionTemplate

@Deprecated(since="ages",
            forRemoval=false)
public class WorkflowActionTemplate
extends GeneratedWorkflowActionTemplate
implements RequirementHolder

Deprecated.

since ages - as of release 4.3, please useWorkflowActionTemplateModel

An action template used for creating new actions.

See Also:

• Serialized Form

Nested Class Summary

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

GenericItem.GenericItemImpl

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.jalo.GeneratedWorkflowActionTemplate

CREATIONTYPE, DECISIONTEMPLATES, DECISIONTEMPLATESHANDLER, DEFAULT_INITIAL_ATTRIBUTES, INCOMINGLINKTEMPLATES, INCOMINGLINKTEMPLATESSTR, INCOMINGTEMPLATEDECISIONS, WORKFLOW, WORKFLOWACTIONTEMPLATELINKTEMPLATERELATION_MARKMODIFIED, WORKFLOWACTIONTEMPLATELINKTEMPLATERELATION_SRC_ORDERED, WORKFLOWACTIONTEMPLATELINKTEMPLATERELATION_TGT_ORDERED, WORKFLOWHANDLER, WORKFLOWPOS

Fields inherited from class de.hybris.platform.workflow.jalo.GeneratedAbstractWorkflowAction

ACTIONTYPE, CODE, DESCRIPTION, EMAILADDRESS, NAME, PREDECESSORS, PREDECESSORSSTR, PRINCIPALASSIGNED, RENDERERTEMPLATE, SENDEMAIL, SUCCESSORS, WORKFLOWACTIONCOMMENTS, WORKFLOWACTIONCOMMENTSHANDLER, WORKFLOWACTIONORDERINGRELATION_MARKMODIFIED, WORKFLOWACTIONORDERINGRELATION_SRC_ORDERED, WORKFLOWACTIONORDERINGRELATION_TGT_ORDERED

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, HJMPTS, 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	Description
WorkflowActionTemplate()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addToPredecessors(SessionContext ctx, AbstractWorkflowAction value)	Deprecated. since ages
void	addToSuccessors(SessionContext ctx, AbstractWorkflowAction value)	Deprecated. since ages
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Deprecated. Has to be implemented for each concrete subtype of item.
WorkflowAction	createWorkflowAction(Workflow workflow)	Deprecated. since ages - as of release 4.3, please use WorkflowActionService.createWorkflowAction(de.hybris.platform.workflow.model.WorkflowActionTemplateModel, de.hybris.platform.workflow.model.WorkflowModel)
ComposedType	getCreationType(SessionContext ctx)	Deprecated. Generated method - Getter of the WorkflowActionTemplate.creationType attribute.
long	getDecisionsCount()	Deprecated. since ages - as of release 4.3, please write your own flexible search query
List<Link>	getIncomingLinkTemplates(SessionContext ctx)	Deprecated. Generated method - Getter of the WorkflowActionTemplate.incomingLinkTemplates attribute.
String	getIncomingLinkTemplatesStr(SessionContext ctx)	Deprecated. Generated method - Getter of the WorkflowActionTemplate.incomingLinkTemplatesStr attribute.
Set<? extends RequirementHolder>	getRequirements()	Deprecated.
protected void	perform(WorkflowAction action)	Deprecated. Will be called after activation of given action.
void	remove(SessionContext ctx)	Deprecated. Removes this item.
void	setCreationType(SessionContext ctx, ComposedType value)	Deprecated. Generated method - Setter of the WorkflowActionTemplate.creationType attribute.

Methods inherited from class de.hybris.platform.workflow.jalo.GeneratedWorkflowActionTemplate

addToDecisionTemplates, addToDecisionTemplates, addToIncomingTemplateDecisions, addToIncomingTemplateDecisions, getCreationType, getDecisionTemplates, getDecisionTemplates, getDefaultAttributeModes, getIncomingLinkTemplates, getIncomingLinkTemplatesStr, getIncomingTemplateDecisions, getIncomingTemplateDecisions, getIncomingTemplateDecisionsCount, getIncomingTemplateDecisionsCount, getWorkflow, getWorkflow, isMarkModifiedDisabled, removeFromDecisionTemplates, removeFromDecisionTemplates, removeFromIncomingTemplateDecisions, removeFromIncomingTemplateDecisions, setCreationType, setDecisionTemplates, setDecisionTemplates, setIncomingTemplateDecisions, setIncomingTemplateDecisions, setWorkflow, setWorkflow

Methods inherited from class de.hybris.platform.workflow.jalo.AbstractWorkflowAction

getInitialProperties, getNonInitialAttributes, getPredecessorsStr, setPrincipalAssigned, writeAutomatedComment, writeAutomatedComment

Methods inherited from class de.hybris.platform.workflow.jalo.GeneratedAbstractWorkflowAction

addToPredecessors, addToSuccessors, addToWorkflowActionComments, addToWorkflowActionComments, getActionType, getActionType, getAllDescription, getAllDescription, getAllName, getAllName, getCode, getCode, getDescription, getDescription, getEmailAddress, getEmailAddress, getName, getName, getPredecessors, getPredecessors, getPredecessorsCount, getPredecessorsCount, getPredecessorsStr, getPrincipalAssigned, getPrincipalAssigned, getRendererTemplate, getRendererTemplate, getSuccessors, getSuccessors, getSuccessorsCount, getSuccessorsCount, getWorkflowActionComments, getWorkflowActionComments, isSendEmail, isSendEmail, isSendEmailAsPrimitive, isSendEmailAsPrimitive, removeFromPredecessors, removeFromPredecessors, removeFromSuccessors, removeFromSuccessors, removeFromWorkflowActionComments, removeFromWorkflowActionComments, setActionType, setActionType, setAllDescription, setAllDescription, setAllName, setAllName, setCode, setCode, setDescription, setDescription, setEmailAddress, setEmailAddress, setName, setName, setPredecessors, setPredecessors, setPrincipalAssigned, setRendererTemplate, setRendererTemplate, setSendEmail, setSendEmail, setSendEmail, setSendEmail, setSuccessors, setSuccessors, setWorkflowActionComments, setWorkflowActionComments

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

getImplementation, getRelatedItems, getRelatedItems, setRelatedItems

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, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPartOfRemovedSessionMarker, 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, notifyManagerAboutItemRemoval, readResolve, 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, suppressRelation, toString, useTA, writeReplace

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

setTenant

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowActionTemplate

public WorkflowActionTemplate()

Deprecated.

Method Details

createItem

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

Deprecated.

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GeneratedWorkflowActionTemplate

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

createWorkflowAction

@Deprecated(since="ages",
            forRemoval=false)
public WorkflowAction createWorkflowAction(Workflow workflow)

Deprecated.

since ages - as of release 4.3, please use WorkflowActionService.createWorkflowAction(de.hybris.platform.workflow.model.WorkflowActionTemplateModel, de.hybris.platform.workflow.model.WorkflowModel)

Creates a new action instance using attributes of this action template.

Parameters:

workflow - workflow instance set to created action

Returns:

created action instance

addToPredecessors

@Deprecated(since="ages",
            forRemoval=false)
public void addToPredecessors(SessionContext ctx,
 AbstractWorkflowAction value)

Deprecated.

since ages

Description copied from class: GeneratedAbstractWorkflowAction

Generated method - Adds value to predecessors.

Overrides:

addToPredecessors in class GeneratedAbstractWorkflowAction

value - the item to add to predecessors

addToSuccessors

@Deprecated(since="ages",
            forRemoval=false)
public void addToSuccessors(SessionContext ctx,
 AbstractWorkflowAction value)

Deprecated.

since ages

Description copied from class: GeneratedAbstractWorkflowAction

Generated method - Adds value to successors.

Overrides:

addToSuccessors in class GeneratedAbstractWorkflowAction

value - the item to add to successors

getRequirements

public Set<? extends RequirementHolder> getRequirements()

Deprecated.

Specified by:

getRequirements in interface RequirementHolder

perform

protected void perform(WorkflowAction action)

Deprecated.

Will be called after activation of given action. Override this method for adding your own action logic. For finishing of this action you can call WorkflowAction.reject() or WorkflowAction.complete().

Parameters:

action - action instance which has to be performed, use settings from this action, not from this template

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Deprecated.

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

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

getIncomingLinkTemplates

public List<Link> getIncomingLinkTemplates(SessionContext ctx)

Deprecated.

Description copied from class: GeneratedWorkflowActionTemplate

Generated method - Getter of the WorkflowActionTemplate.incomingLinkTemplates attribute.

Specified by:

getIncomingLinkTemplates in class GeneratedWorkflowActionTemplate

Returns:

the incomingLinkTemplates

getIncomingLinkTemplatesStr

public String getIncomingLinkTemplatesStr(SessionContext ctx)

Deprecated.

Description copied from class: GeneratedWorkflowActionTemplate

Generated method - Getter of the WorkflowActionTemplate.incomingLinkTemplatesStr attribute.

Specified by:

getIncomingLinkTemplatesStr in class GeneratedWorkflowActionTemplate

Returns:

comma separated string with all action with decisions linking on this action

getDecisionsCount

@Deprecated(since="ages",
            forRemoval=false)
public long getDecisionsCount()

Deprecated.

since ages - as of release 4.3, please write your own flexible search query

Returns the number of decisions of this workflow action

Returns:

number of decisions

getCreationType

public ComposedType getCreationType(SessionContext ctx)

Deprecated.

Description copied from class: GeneratedWorkflowActionTemplate

Generated method - Getter of the WorkflowActionTemplate.creationType attribute.

Specified by:

getCreationType in class GeneratedWorkflowActionTemplate

Returns:

the creationType

setCreationType

public void setCreationType(SessionContext ctx,
 ComposedType value)

Deprecated.

Description copied from class: GeneratedWorkflowActionTemplate

Generated method - Setter of the WorkflowActionTemplate.creationType attribute.

Specified by:

setCreationType in class GeneratedWorkflowActionTemplate

value - the creationType