Class WorkflowAction
- All Implemented Interfaces:
Serializable,Comparable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem
GenericItem.GenericItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImplNested 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.GeneratedWorkflowAction
ACTIVATED, ATTACHMENTITEMS, ATTACHMENTS, COMMENT, DECISIONS, DECISIONSHANDLER, DEFAULT_INITIAL_ATTRIBUTES, FIRSTACTIVATED, INCOMINGDECISIONS, INCOMINGLINKS, INCOMINGLINKSSTR, SELECTEDDECISION, STATUS, TEMPLATE, WORKFLOW, WORKFLOWACTIONITEMATTACHMENTRELATION_MARKMODIFIED, WORKFLOWACTIONITEMATTACHMENTRELATION_SRC_ORDERED, WORKFLOWACTIONITEMATTACHMENTRELATION_TGT_ORDERED, WORKFLOWACTIONLINKRELATION_MARKMODIFIED, WORKFLOWACTIONLINKRELATION_SRC_ORDERED, WORKFLOWACTIONLINKRELATION_TGT_ORDERED, WORKFLOWHANDLER, WORKFLOWPOSFields 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_ORDEREDFields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLEDFields 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, TYPEFields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidactivate()Deprecated.Sets the status of this action to active if it is not disabled.voidDeprecated.since ages - as of release 4.3, private method inWorkflowProcessingServicevoidcomplete()Deprecated.Sets the status tocompleteand tries to activate all successors.protected ItemcreateItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Deprecated.Has to be implemented for each concrete subtype of item.voiddecide()Deprecated.since ages - as of release 4.3, please useWorkflowProcessingService.decideAction(WorkflowActionModel, de.hybris.platform.workflow.model.WorkflowDecisionModel)voiddisable()Deprecated.Disables the action.static EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.IN_PROGRESSDeprecated.Generated method - Getter of theWorkflowAction.attachmentItemsattribute.static EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.COMPLETEDgetDecisionByName(String name) Deprecated.Returns the decision with the given name, if this action has no such decision, returns null.longDeprecated.since ages - as of release 4.3, useWorkflowActionModel.getDecisions()static EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.DISABLEDstatic EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionType.ENDstatic EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.ENDED_THROUGH_END_OF_WORKFLOWstatic EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.PENDINGDeprecated.since ages - as of release 4.3, private method inWorkflowProcessingServiceDeprecated.Generated method - Getter of theWorkflowAction.incomingLinksStrattribute.static EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionType.NORMALstatic EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionType.STARTstatic EnumerationValueDeprecated.since ages - as of release 4.3, please useWorkflowActionStatus.TERMINATEDprotected voididle()Deprecated.Set the status of this action toidlewithout further checks.booleanisActive()Deprecated.since ages - as of release 4.3, please use status comparisonbooleanDeprecated.since ages - as of release 4.3, please useWorkflowActionService.isCompleted(de.hybris.platform.workflow.model.WorkflowActionModel)booleanDeprecated.since ages - as of release 4.3, please use status comparisonbooleanDeprecated.since ages - as of release 4.3, please use status comparisonbooleanDeprecated.since ages - as of release 4.3, please useWorkflowActionService.isUserAssignedPrincipal(de.hybris.platform.workflow.model.WorkflowActionModel)protected booleanDeprecated.since ages - Checks whether all predecessors are completed.voidreject()Deprecated.since ages - Rejects the action.protected voidDeprecated.since ages - as of release 4.3, please useEmailService.createActivationEmail(de.hybris.platform.workflow.model.WorkflowActionModel)voidDeprecated.since ages - Tries to activate the action.protected voidDeprecated.since ages - Tries to activate all predecessors.protected voidDeprecated.since ages - Tries to activate all successors.Methods inherited from class de.hybris.platform.workflow.jalo.GeneratedWorkflowAction
addToAttachments, addToAttachments, addToDecisions, addToDecisions, addToIncomingDecisions, addToIncomingDecisions, getActivated, getActivated, getAttachmentItems, getAttachments, getAttachments, getAttachmentsCount, getAttachmentsCount, getComment, getComment, getDecisions, getDecisions, getDefaultAttributeModes, getFirstActivated, getFirstActivated, getIncomingDecisions, getIncomingDecisions, getIncomingDecisionsCount, getIncomingDecisionsCount, getIncomingLinks, getIncomingLinksStr, getSelectedDecision, getSelectedDecision, getStatus, getStatus, getTemplate, getTemplate, getWorkflow, getWorkflow, isMarkModifiedDisabled, removeFromAttachments, removeFromAttachments, removeFromDecisions, removeFromDecisions, removeFromIncomingDecisions, removeFromIncomingDecisions, setActivated, setActivated, setAttachments, setAttachments, setComment, setComment, setDecisions, setDecisions, setFirstActivated, setFirstActivated, setIncomingDecisions, setIncomingDecisions, setSelectedDecision, setSelectedDecision, setStatus, setStatus, setTemplate, setTemplate, setWorkflow, setWorkflowMethods inherited from class de.hybris.platform.workflow.jalo.AbstractWorkflowAction
getInitialProperties, getNonInitialAttributes, getPredecessorsStr, setPrincipalAssigned, writeAutomatedComment, writeAutomatedCommentMethods inherited from class de.hybris.platform.workflow.jalo.GeneratedAbstractWorkflowAction
addToPredecessors, addToPredecessors, addToSuccessors, 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, setWorkflowActionCommentsMethods inherited from class de.hybris.platform.jalo.GenericItem
getImplementation, getRelatedItems, getRelatedItems, setRelatedItemsMethods 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, setLocalizedPropertyMethods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setPropertyMethods 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, 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, writeReplaceMethods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
Constructor Details
-
WorkflowAction
public WorkflowAction()Deprecated.
-
-
Method Details
-
getStartActionType
Deprecated.since ages - as of release 4.3, please useWorkflowActionType.STARTGets the constant value for the
startactiontype.- Returns:
- constant for
startactiontype
-
getNormalActionType
Deprecated.since ages - as of release 4.3, please useWorkflowActionType.NORMALGets the constant value for the
normalactiontype.- Returns:
- constant for
normalactiontype
-
getEndActionType
Deprecated.since ages - as of release 4.3, please useWorkflowActionType.ENDGets the constant value for the
endactiontype.- Returns:
- constant for
endactiontype
-
getActiveStatus
Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.IN_PROGRESSGets the constant value for the
activestatus.- Returns:
- constant for
activestatus
-
getIdleStatus
Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.PENDINGGets the constant value for the
idlestatus.- Returns:
- constant for
idlestatus
-
getCompletedStatus
Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.COMPLETEDGets the constant value for the
completedstatus.- Returns:
- constant for
completedstatus
-
getEndedByWorkflowStatus
@Deprecated(since="ages", forRemoval=false) public static EnumerationValue getEndedByWorkflowStatus()Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.ENDED_THROUGH_END_OF_WORKFLOWGets the constant value for the
endThroughEndOfWorkflowstatus.- Returns:
- constant for
endThroughEndOfWorkflowstatus
-
getDisabledStatus
Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.DISABLEDGets the constant value for the
disabledstatus.- Returns:
- constant for
disabledstatus
-
getTerminatedStatus
Deprecated.since ages - as of release 4.3, please useWorkflowActionStatus.TERMINATEDGets the constant value for the
terminatedstatus.- Returns:
- constant for
terminatedstatus
-
createItem
protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException Deprecated.Description copied from class:ItemHas 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. ) duringComposedType.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:
createItemin classGeneratedWorkflowAction- Parameters:
ctx- the current session context which this item is created withintype- 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
-
activate
protected void activate()Deprecated.Sets the status of this action to active if it is not disabled. Sets new status, new activated date, first activated flag optional and optional sends activation mail. -
sendActivationEmail
Deprecated.since ages - as of release 4.3, please useEmailService.createActivationEmail(de.hybris.platform.workflow.model.WorkflowActionModel)Sends the activation mail.
-
idle
protected void idle()Deprecated.Set the status of this action toidlewithout further checks. -
isDisabled
Deprecated.since ages - as of release 4.3, please use status comparisonChecks whether the action is disabled.
- Returns:
- true if the action is disabled, false otherwise
-
isEndedByWorkflow
Deprecated.since ages - as of release 4.3, please use status comparison -
isActive
Deprecated.since ages - as of release 4.3, please use status comparisonChecks whether the action is active.
- Returns:
- true if the action is action, false otherwise
-
isCompleted
Deprecated.since ages - as of release 4.3, please useWorkflowActionService.isCompleted(de.hybris.platform.workflow.model.WorkflowActionModel)Checks whether the action is completed.
- Returns:
- true if the action is completed, false otherwise
-
disable
public void disable()Deprecated.Disables the action. -
tryActivate
Deprecated.since ages - Tries to activate the action. If the action is already completed, it will try to activate its successors. If the action is not completed and all predecessors are completed the action will be activated. -
predecessorsCompleted
Deprecated.since ages - Checks whether all predecessors are completed.- Returns:
- true if all predecessors are completed, false otherwise
-
tryActivateSuccessors
Deprecated.since ages - Tries to activate all successors. -
tryActivatePredecessors
Deprecated.since ages - Tries to activate all predecessors. -
complete
public void complete()Deprecated.Sets the status tocompleteand tries to activate all successors. -
reject
Deprecated.since ages - Rejects the action. Sets the status toidleand activates all predecessors. -
checkIncomingLinks
@Deprecated(since="ages", forRemoval=false) public void checkIncomingLinks() throws JaloInvalidParameterException, JaloBusinessExceptionDeprecated.since ages - as of release 4.3, private method inWorkflowProcessingServiceThis method gets called by its predecessors in the workflow. It checks if its conditions for activation are met and calls the activate() method if so.
-
decide
Deprecated.since ages - as of release 4.3, please useWorkflowProcessingService.decideAction(WorkflowActionModel, de.hybris.platform.workflow.model.WorkflowDecisionModel)completes the workflow action and activates the selected decision
- Throws:
WorkflowActionDecideException- if user is not assigned principal but ignores it for automated workflow actions
-
getDecisionByName
Deprecated.Returns the decision with the given name, if this action has no such decision, returns null.- Parameters:
name-- Returns:
- The WorkflowDecision with the given name. If there is no such WorkflowDecision it returns null.
-
getIncomingLinks
Deprecated.since ages - as of release 4.3, private method inWorkflowProcessingServiceDescription copied from class:GeneratedWorkflowActionGenerated method - Getter of theWorkflowAction.incomingLinksattribute.- Specified by:
getIncomingLinksin classGeneratedWorkflowAction- Returns:
- the incomingLinks
-
getIncomingLinksStr
Deprecated.Description copied from class:GeneratedWorkflowActionGenerated method - Getter of theWorkflowAction.incomingLinksStrattribute.- Specified by:
getIncomingLinksStrin classGeneratedWorkflowAction- Returns:
- comma seperated string with all action with decisions linking on this action
-
getDecisionsCount
Deprecated.since ages - as of release 4.3, useWorkflowActionModel.getDecisions()Returns the number of decisions of this workflow action
- Returns:
- number of decisions
-
getAttachmentItems
Deprecated.Description copied from class:GeneratedWorkflowActionGenerated method - Getter of theWorkflowAction.attachmentItemsattribute.- Specified by:
getAttachmentItemsin classGeneratedWorkflowAction- Returns:
- the attachmentItems
-
isUserAssignedPrincipal
Deprecated.since ages - as of release 4.3, please useWorkflowActionService.isUserAssignedPrincipal(de.hybris.platform.workflow.model.WorkflowActionModel)checks if the user is a assigned principal for this action
- Returns:
- whether the user is a assigned principal
-
WorkflowActionModelRepresents a real action which is created by a
WorkflowActionTemplate. It holds a status signalizing the current state the action is in.