Package de.hybris.platform.workflow.services.impl

Class WorkflowServiceImpl

java.lang.Object

de.hybris.platform.workflow.services.impl.WorkflowServiceImpl

All Implemented Interfaces:

WorkflowService

Direct Known Subclasses:

CmsWorkflowServiceImpl

@Deprecated(since="ages",
            forRemoval=true)
public class WorkflowServiceImpl
extends Object
implements WorkflowService

Deprecated, for removal: This API element is subject to removal in a future version.

since ages - UseDefaultWorkflowService instead.

Field Summary

Fields inherited from interface de.hybris.platform.workflow.services.WorkflowService

ACTION_CREATE, ACTION_REMOVE, ACTION_SAVE

Constructor Summary

Constructors

Constructor	Description
WorkflowServiceImpl()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	addComment(Object comment, WorkflowActionModel action)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addItems(ItemModel workflowModel, List<ItemModel> itemsToAdd)	Deprecated, for removal: This API element is subject to removal in a future version.
void	assignUser(PrincipalModel principalModel, WorkflowModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canBeStarted(WorkflowModel workf)	Deprecated, for removal: This API element is subject to removal in a future version.
ItemModel	containsItem(ItemModel workflowModel, List<ItemModel> itemsToAdd)	Deprecated, for removal: This API element is subject to removal in a future version.
WorkflowModel	createAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd)	Deprecated, for removal: This API element is subject to removal in a future version.
WorkflowModel	createWorkflow(WorkflowTemplateModel templateModel, ItemModel itemModel)	Deprecated, for removal: This API element is subject to removal in a future version. Creates workflow out of given template and starts it.
WorkflowModel	createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd)	Deprecated, for removal: This API element is subject to removal in a future version. Creates workflow out of given template with given name but does NOT start it.
void	decideAction(WorkflowActionModel action, WorkflowDecisionModel decision)	Deprecated, for removal: This API element is subject to removal in a future version.
void	evaluteActivationScripts(ItemModel itemModel, Map currentValues, Map initialValues, String action)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getAllUserWorkflowActionsWithAttachment(String attachmentClassName)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames, Collection<WorkflowActionStatus> actionStatuses)	Deprecated, for removal: This API element is subject to removal in a future version. * @deprecated as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachments(List, Collection)
List<WorkflowTemplateModel>	getAllVisibleWorkflowTemplates()	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowModel>	getAllWorkflows(int workflowsStatuses, int adhocWorkflowsStatuses, Date dateFrom, Date dateTo, Date adhocDateFrom, Date adhocDateTo)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowTemplateModel>	getAllWorkflowTemplates()	Deprecated, for removal: This API element is subject to removal in a future version.
List<ItemModel>	getAttachmentsForAction(WorkflowActionModel action)	Deprecated, for removal: This API element is subject to removal in a future version.
List<ItemModel>	getAttachmentsForAction(WorkflowActionModel action, String attachmentClassName)	Deprecated, for removal: This API element is subject to removal in a future version.
List<ItemModel>	getAttachmentsForAction(WorkflowActionModel action, List<String> attachmentClassNames)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionCommentModel>	getCommentsForAction(WorkflowActionModel action)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowDecisionModel>	getDecisionsForAction(WorkflowActionModel action)	Deprecated, for removal: This API element is subject to removal in a future version. since ages - as of release 4.3, please useWorkflowActionModel.getDecisions()
List<WorkflowActionModel>	getEndWorkflowActions(WorkflowModel wfModel)	Deprecated, for removal: This API element is subject to removal in a future version.
protected bsh.Interpreter	getInterpreter()	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getNormalWorkflowActions(WorkflowModel wfModel)	Deprecated, for removal: This API element is subject to removal in a future version.
Date	getStartTime(WorkflowModel workflow)	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getStartWorkflowActions(WorkflowModel wfModel)	Deprecated, for removal: This API element is subject to removal in a future version.
UserService	getUserService()	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowActionModel>	getWorkflowActionsByType(EnumerationValue type, WorkflowModel wfModel)	Deprecated, for removal: This API element is subject to removal in a future version.
WorkflowDAO	getWorkflowDao()	Deprecated, for removal: This API element is subject to removal in a future version.
List<WorkflowModel>	getWorkflowsByTemplate(WorkflowTemplateModel template)	Deprecated, for removal: This API element is subject to removal in a future version. since ages - as of release 4.3, please use WorkflowService.getWorkflowsForTemplateAndUser(de.hybris.platform.workflow.model.WorkflowTemplateModel, UserModel)
boolean	isAdhocWorkflow(WorkflowModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isAutomatedComment(WorkflowActionCommentModel comment)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
boolean	isFinished(Object workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isPaused(Object workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isPlanned(Object workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isRunning(Object workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version. * @deprecated as of release 4.3, please use WorkflowService.isRunning(WorkflowModel)
boolean	isTerminated(Object workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setModelService(ModelService modelService)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setUserService(UserService userService)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setWorkflowDao(WorkflowDAO workflowDao)	Deprecated, for removal: This API element is subject to removal in a future version.
void	startWorkflow(ItemModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.
void	terminateWorkflow(ItemModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version. * @deprecated as of release 4.3, please use WorkflowProcessingService.terminateWorkflow(WorkflowModel)
void	unassignUser(PrincipalModel principalModel, WorkflowModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowServiceImpl

public WorkflowServiceImpl()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getAllUserWorkflowActionsWithAttachment

public List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(String attachmentClassName)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllUserWorkflowActionsWithAttachment in interface WorkflowService

getAllUserWorkflowActionsWithAttachment

public List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllUserWorkflowActionsWithAttachment in interface WorkflowService

getAllUserWorkflowActionsWithAttachments

public List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllUserWorkflowActionsWithAttachments in interface WorkflowService

getAllUserWorkflowActionsWithAttachments

public List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames,
 Collection<WorkflowActionStatus> actionStatuses)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: WorkflowService

* @deprecated as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachments(List, Collection)

Retrieves workflow actions with specified criteria.

Specified by:

getAllUserWorkflowActionsWithAttachments in interface WorkflowService

Parameters:

attachmentClassNames - list of allowed attachment class names

actionStatuses - allowed action statuses

Returns:

list of workflow actions

getCommentsForAction

public List<WorkflowActionCommentModel> getCommentsForAction(WorkflowActionModel action)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getCommentsForAction in interface WorkflowService

getAttachmentsForAction

public List<ItemModel> getAttachmentsForAction(WorkflowActionModel action)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAttachmentsForAction in interface WorkflowService

getAttachmentsForAction

public List<ItemModel> getAttachmentsForAction(WorkflowActionModel action,
 String attachmentClassName)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAttachmentsForAction in interface WorkflowService

getAttachmentsForAction

public List<ItemModel> getAttachmentsForAction(WorkflowActionModel action,
 List<String> attachmentClassNames)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAttachmentsForAction in interface WorkflowService

getDecisionsForAction

@Deprecated(since="ages",
            forRemoval=true)
public List<WorkflowDecisionModel> getDecisionsForAction(WorkflowActionModel action)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages - as of release 4.3, please useWorkflowActionModel.getDecisions()

Specified by:

getDecisionsForAction in interface WorkflowService

decideAction

public void decideAction(WorkflowActionModel action,
 WorkflowDecisionModel decision)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

decideAction in interface WorkflowService

addComment

public void addComment(Object comment,
 WorkflowActionModel action)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

addComment in interface WorkflowService

evaluteActivationScripts

public void evaluteActivationScripts(ItemModel itemModel,
 Map currentValues,
 Map initialValues,
 String action)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

evaluteActivationScripts in interface WorkflowService

getInterpreter

protected bsh.Interpreter getInterpreter()

Deprecated, for removal: This API element is subject to removal in a future version.

createWorkflow

public WorkflowModel createWorkflow(WorkflowTemplateModel templateModel,
 ItemModel itemModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates workflow out of given template and starts it. Given item is attached to it.

Specified by:

createWorkflow in interface WorkflowService

createWorkflow

public WorkflowModel createWorkflow(String workflowName,
 WorkflowTemplateModel template,
 List<ItemModel> itemsToAdd)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates workflow out of given template with given name but does NOT start it. Given list of items is attached to it.

Specified by:

createWorkflow in interface WorkflowService

isAutomatedComment

@Deprecated(since="ages",
            forRemoval=true)
public boolean isAutomatedComment(WorkflowActionCommentModel comment)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Specified by:

isAutomatedComment in interface WorkflowService

getAllWorkflowTemplates

public List<WorkflowTemplateModel> getAllWorkflowTemplates()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllWorkflowTemplates in interface WorkflowService

getWorkflowsByTemplate

@Deprecated(since="ages",
            forRemoval=true)
public List<WorkflowModel> getWorkflowsByTemplate(WorkflowTemplateModel template)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages - as of release 4.3, please use WorkflowService.getWorkflowsForTemplateAndUser(de.hybris.platform.workflow.model.WorkflowTemplateModel, UserModel)

Specified by:

getWorkflowsByTemplate in interface WorkflowService

getAllWorkflows

public List<WorkflowModel> getAllWorkflows(int workflowsStatuses,
 int adhocWorkflowsStatuses,
 Date dateFrom,
 Date dateTo,
 Date adhocDateFrom,
 Date adhocDateTo)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllWorkflows in interface WorkflowService

Parameters:

workflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for other values

adhocWorkflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for other values

Returns:

List of workflows fulfilling given criteria, e.g. if only planned and running workflows should be returned then put 3 as workflowsStatuses and 0 for adhocWorkflowsStatuses.

getWorkflowDao

public WorkflowDAO getWorkflowDao()

Deprecated, for removal: This API element is subject to removal in a future version.

createAdhocWorkflow

public WorkflowModel createAdhocWorkflow(String defaultName,
 List<ItemModel> itemsToAdd)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

createAdhocWorkflow in interface WorkflowService

Parameters:

defaultName - of adhoc workflow

itemsToAdd - list of items to add

Returns:

created adhoc workflow

setWorkflowDao

public void setWorkflowDao(WorkflowDAO workflowDao)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

workflowDao - the workflowDao to set

assignUser

public void assignUser(PrincipalModel principalModel,
 WorkflowModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

assignUser in interface WorkflowService

Parameters:

principalModel - to assign to given workflow

setModelService

public void setModelService(ModelService modelService)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

modelService - the modelService to set

getAllVisibleWorkflowTemplates

public List<WorkflowTemplateModel> getAllVisibleWorkflowTemplates()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getAllVisibleWorkflowTemplates in interface WorkflowService

Returns:

all visible workflow templates for current session user, including templates that user is owner of, excluding special adhoc-workflow template

getUserService

public UserService getUserService()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

the userService

setUserService

public void setUserService(UserService userService)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

userService - the userService to set

isPaused

public boolean isPaused(Object workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

isPaused in interface WorkflowService

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is paused

startWorkflow

public void startWorkflow(ItemModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

startWorkflow in interface WorkflowService

terminateWorkflow

public void terminateWorkflow(ItemModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: WorkflowService

* @deprecated as of release 4.3, please use WorkflowProcessingService.terminateWorkflow(WorkflowModel)

terminate given (adhoc) workflow

Specified by:

terminateWorkflow in interface WorkflowService

isTerminated

public boolean isTerminated(Object workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

isTerminated in interface WorkflowService

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is terminated

isPlanned

public boolean isPlanned(Object workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

isPlanned in interface WorkflowService

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is planned

isRunning

public boolean isRunning(Object workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: WorkflowService

* @deprecated as of release 4.3, please use WorkflowService.isRunning(WorkflowModel)

Specified by:

isRunning in interface WorkflowService

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is running

isFinished

public boolean isFinished(Object workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

isFinished in interface WorkflowService

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is finished

addItems

public void addItems(ItemModel workflowModel,
 List<ItemModel> itemsToAdd)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

addItems in interface WorkflowService

containsItem

public ItemModel containsItem(ItemModel workflowModel,
 List<ItemModel> itemsToAdd)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

containsItem in interface WorkflowService

Returns:

first item from given list found in workflow, null otherwise

isAdhocWorkflow

public boolean isAdhocWorkflow(WorkflowModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

isAdhocWorkflow in interface WorkflowService

Returns:

true if given workflow was created out of adhoc-workflow template

canBeStarted

public boolean canBeStarted(WorkflowModel workf)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

canBeStarted in interface WorkflowService

Returns:

true if given workflow can be started, false otherwise (e.g. when there are is no user assigned)

getStartTime

public Date getStartTime(WorkflowModel workflow)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getStartTime in interface WorkflowService

Returns:

start time of given workflow

unassignUser

public void unassignUser(PrincipalModel principalModel,
 WorkflowModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

unassignUser in interface WorkflowService

Parameters:

principalModel - to unassign from given adhoc workflow

getStartWorkflowActions

public List<WorkflowActionModel> getStartWorkflowActions(WorkflowModel wfModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getStartWorkflowActions in interface WorkflowService

Returns:

all workflow actions that are marked as 'start action'

getNormalWorkflowActions

public List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel wfModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getNormalWorkflowActions in interface WorkflowService

Returns:

all workflow actions that are marked as 'normal action'

getEndWorkflowActions

public List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel wfModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getEndWorkflowActions in interface WorkflowService

Returns:

all workflow actions that are marked as 'end action'

getWorkflowActionsByType

public List<WorkflowActionModel> getWorkflowActionsByType(EnumerationValue type,
 WorkflowModel wfModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getWorkflowActionsByType in interface WorkflowService

Returns:

all workflow actions which are of given type