de.hybris.platform.workflow.impl

Class DefaultWorkflowService

java.lang.Object

de.hybris.platform.workflow.impl.DefaultWorkflowService

All Implemented Interfaces:

WorkflowService

public class DefaultWorkflowService
extends java.lang.Object
implements WorkflowService

Default implementation of WorkflowService

Constructor Summary

Constructors

Constructor and Description
DefaultWorkflowService()

Method Summary

Modifier and Type	Method and Description
boolean	assignUser(PrincipalModel principalModel, WorkflowModel workflowModel) Assigns principal to workflow.
boolean	canBeStarted(WorkflowModel workf) Checks if workflow can be started
WorkflowModel	createAdhocWorkflow(java.lang.String defaultName, java.util.List<ItemModel> itemsToAdd, UserModel owner) Creates adhoc workflow with a name and adds an attachment to it.
WorkflowModel	createWorkflow(java.lang.String workflowName, WorkflowTemplateModel template, java.util.List<ItemModel> itemsToAdd, UserModel owner) Creates workflow based on a template and adds an attachment to it.
WorkflowModel	createWorkflow(WorkflowTemplateModel template, ItemModel attachmentItem, UserModel owner) Creates workflow based on a template and adds an attachment to it.
WorkflowModel	createWorkflow(WorkflowTemplateModel template, UserModel owner) Creates workflow based on a template.
java.util.List<WorkflowModel>	getAllAdhocWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses, java.util.Date adhocDateFrom, java.util.Date adhocDateTo) Returns addhoc workflows that match statuses and time range.
SearchResult<WorkflowModel>	getAllAdhocWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses, java.util.Date adhocDateFrom, java.util.Date adhocDateTo, int startIndex, int pageSize) Pageable version of method WorkflowService.getAllAdhocWorkflows(EnumSet, Date, Date)
java.util.List<WorkflowModel>	getAllWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses, java.util.Date dateFrom, java.util.Date dateTo) Returns workflows that match statuses and time range.
SearchResult<WorkflowModel>	getAllWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses, java.util.Date dateFrom, java.util.Date dateTo, int startIndex, int pageSize) Pageable version of method WorkflowService.getAllWorkflows(EnumSet, Date, Date)
java.util.Date	getStartTime(WorkflowModel workflow) Gets start time from a workflow
protected WorkflowActionModel	getWorkAction(WorkflowActionTemplateModel templateAction, java.util.List<WorkflowActionModel> workflowActions)
WorkflowModel	getWorkflowForCode(java.lang.String code) Returns workflow for a given code
java.util.List<WorkflowModel>	getWorkflowsForTemplateAndUser(WorkflowTemplateModel template, UserModel user) Returns workflows that was created from given template whom owner is given user .
boolean	isAdhocWorkflow(WorkflowModel workflowModel) Checks if workflow is adhoc
boolean	isCompleted(WorkflowModel workflowModel) Checks if workflow is completed
boolean	isFinished(WorkflowModel workflowModel) Checks if workflow is finished
boolean	isPaused(WorkflowModel workflowModel) Checks if workflow is paused
boolean	isPlanned(WorkflowModel workflowModel) Checks if workflow is planned
boolean	isRunning(WorkflowModel workflowModel) Checks if workflow is running
boolean	isTerminated(WorkflowModel workflowModel) Checks if workflow is terminated
void	setActionsWorkflowTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowTemplateModel,java.util.List<WorkflowActionModel>> actionsFromWorkflowTemplate)
void	setDecisionsActionTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowActionTemplateModel,java.util.List<WorkflowDecisionModel>> decisionsFromActionTemplate)
void	setModelService(ModelService modelService)
void	setPredecessorsActionTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowActionTemplateModel,java.util.List<AbstractWorkflowActionModel>> predecessorsFromActionTemplate)
void	setWorkflowActionService(WorkflowActionService workflowActionService)
void	setWorkflowDao(WorkflowDao workflowDao)
void	setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)
boolean	unassignUser(WorkflowModel workflowModel) Unassigns principal from workflow and assign dummy user
void	writeAutomatedComment(WorkflowActionModel action, java.lang.String message, java.lang.String... messageParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWorkflowService

public DefaultWorkflowService()

Method Detail

setActionsWorkflowTemplateFactory

public void setActionsWorkflowTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowTemplateModel,java.util.List<WorkflowActionModel>> actionsFromWorkflowTemplate)

setDecisionsActionTemplateFactory

public void setDecisionsActionTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowActionTemplateModel,java.util.List<WorkflowDecisionModel>> decisionsFromActionTemplate)

setPredecessorsActionTemplateFactory

public void setPredecessorsActionTemplateFactory(WorkflowFactory<WorkflowModel,WorkflowActionTemplateModel,java.util.List<AbstractWorkflowActionModel>> predecessorsFromActionTemplate)

getWorkflowsForTemplateAndUser

public java.util.List<WorkflowModel> getWorkflowsForTemplateAndUser(WorkflowTemplateModel template,
                                                                    UserModel user)

Description copied from interface: WorkflowService

Returns workflows that was created from given template whom owner is given user .

Specified by:

getWorkflowsForTemplateAndUser in interface WorkflowService

Parameters:

template - to be matched

user - owner of the workflow

isTerminated

public boolean isTerminated(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is terminated

Specified by:

isTerminated in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if terminated, false otherwise

createWorkflow

public WorkflowModel createWorkflow(WorkflowTemplateModel template,
                                    ItemModel attachmentItem,
                                    UserModel owner)

Description copied from interface: WorkflowService

Creates workflow based on a template and adds an attachment to it. It does not save workflow and actions, please do it by yourself.

Specified by:

createWorkflow in interface WorkflowService

Parameters:

template - from which workflow is being created

attachmentItem - to be added

Returns:

created workflow

createWorkflow

public WorkflowModel createWorkflow(java.lang.String workflowName,
                                    WorkflowTemplateModel template,
                                    java.util.List<ItemModel> itemsToAdd,
                                    UserModel owner)

Description copied from interface: WorkflowService

Creates workflow based on a template and adds an attachment to it. It does not save workflow and actions, please do it by yourself.

Specified by:

createWorkflow in interface WorkflowService

Parameters:

workflowName - name of a workflow

template - from which workflow is being created

itemsToAdd - attachment items to be added

Returns:

created workflow

createWorkflow

public WorkflowModel createWorkflow(WorkflowTemplateModel template,
                                    UserModel owner)

Description copied from interface: WorkflowService

Creates workflow based on a template. It does not save workflow and actions, please do it by yourself.

Specified by:

createWorkflow in interface WorkflowService

Parameters:

template - from which workflow is being created

owner - of the workflow

Returns:

created workflow

getAllWorkflows

public java.util.List<WorkflowModel> getAllWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses,
                                                     java.util.Date dateFrom,
                                                     java.util.Date dateTo)

Description copied from interface: WorkflowService

Returns workflows that match statuses and time range. Workflow meets the time range when its ItemModel.getModifiedtime() is between given adhocDateFrom and adhocDateTo.

Specified by:

getAllWorkflows in interface WorkflowService

Parameters:

workflowsStatuses - statuses to be match

dateFrom - time range start

dateTo - time range end

Returns:

workflows that match critetia

getAllAdhocWorkflows

public java.util.List<WorkflowModel> getAllAdhocWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses,
                                                          java.util.Date adhocDateFrom,
                                                          java.util.Date adhocDateTo)

Description copied from interface: WorkflowService

Returns addhoc workflows that match statuses and time range. Workflow meets the time range when its ItemModel.getModifiedtime() is between given adhocDateFrom and adhocDateTo.

Specified by:

getAllAdhocWorkflows in interface WorkflowService

Parameters:

workflowsStatuses - statuses to be match

adhocDateFrom - time range start

adhocDateTo - time range end

Returns:

adhoc workflows that match critetia

getAllWorkflows

public SearchResult<WorkflowModel> getAllWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses,
                                                   java.util.Date dateFrom,
                                                   java.util.Date dateTo,
                                                   int startIndex,
                                                   int pageSize)

Description copied from interface: WorkflowService

Pageable version of method WorkflowService.getAllWorkflows(EnumSet, Date, Date)

Specified by:

getAllWorkflows in interface WorkflowService

getAllAdhocWorkflows

public SearchResult<WorkflowModel> getAllAdhocWorkflows(java.util.EnumSet<WorkflowStatus> workflowsStatuses,
                                                        java.util.Date adhocDateFrom,
                                                        java.util.Date adhocDateTo,
                                                        int startIndex,
                                                        int pageSize)

Description copied from interface: WorkflowService

Pageable version of method WorkflowService.getAllAdhocWorkflows(EnumSet, Date, Date)

Specified by:

getAllAdhocWorkflows in interface WorkflowService

isPlanned

public boolean isPlanned(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is planned

Specified by:

isPlanned in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if planned, false otherwise

isRunning

public boolean isRunning(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is running

Specified by:

isRunning in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if running, false otherwise

isFinished

public boolean isFinished(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is finished

Specified by:

isFinished in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if planned, false otherwise

isPaused

public boolean isPaused(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is paused

Specified by:

isPaused in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if paused, false otherwise

isCompleted

public boolean isCompleted(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is completed

Specified by:

isCompleted in interface WorkflowService

Parameters:

workflowModel - to check

Returns:

true if completed, false otherwise

getWorkAction

protected WorkflowActionModel getWorkAction(WorkflowActionTemplateModel templateAction,
                                            java.util.List<WorkflowActionModel> workflowActions)

writeAutomatedComment

public void writeAutomatedComment(WorkflowActionModel action,
                                  java.lang.String message,
                                  java.lang.String... messageParams)

isAdhocWorkflow

public boolean isAdhocWorkflow(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Checks if workflow is adhoc

Specified by:

isAdhocWorkflow in interface WorkflowService

Parameters:

workflowModel - to check

canBeStarted

public boolean canBeStarted(WorkflowModel workf)

Description copied from interface: WorkflowService

Checks if workflow can be started

Specified by:

canBeStarted in interface WorkflowService

Parameters:

workf - to check

Returns:

true if can be started, false otherwise

getStartTime

public java.util.Date getStartTime(WorkflowModel workflow)

Description copied from interface: WorkflowService

Gets start time from a workflow

Specified by:

getStartTime in interface WorkflowService

Returns:

start date of workflow

createAdhocWorkflow

public WorkflowModel createAdhocWorkflow(java.lang.String defaultName,
                                         java.util.List<ItemModel> itemsToAdd,
                                         UserModel owner)

Description copied from interface: WorkflowService

Creates adhoc workflow with a name and adds an attachment to it. This method does not save workflow, do it by yourself.

Specified by:

createAdhocWorkflow in interface WorkflowService

Parameters:

defaultName - name of a workflow

itemsToAdd - attachment items to be added

owner - of the workflow

Returns:

created workflow

assignUser

public boolean assignUser(PrincipalModel principalModel,
                          WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Assigns principal to workflow. This action does not save workflow, please do it by yourself.

Specified by:

assignUser in interface WorkflowService

Parameters:

principalModel - to be assigned to workflow

unassignUser

public boolean unassignUser(WorkflowModel workflowModel)

Description copied from interface: WorkflowService

Unassigns principal from workflow and assign dummy user

Specified by:

unassignUser in interface WorkflowService

getWorkflowForCode

public WorkflowModel getWorkflowForCode(java.lang.String code)

Description copied from interface: WorkflowService

Returns workflow for a given code

Specified by:

getWorkflowForCode in interface WorkflowService

setModelService

public void setModelService(ModelService modelService)

Parameters:

modelService - the modelService to set

setWorkflowActionService

public void setWorkflowActionService(WorkflowActionService workflowActionService)

Parameters:

workflowActionService - the workflowActionService to set

setWorkflowDao

public void setWorkflowDao(WorkflowDao workflowDao)

Parameters:

workflowDao - the workflowDao to set

setWorkflowTemplateService

public void setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)

Parameters:

workflowTemplateService - the workflowTemplateService to set