Package de.hybris.platform.workflow.impl
Class DefaultWorkflowService
java.lang.Object
de.hybris.platform.workflow.impl.DefaultWorkflowService
- All Implemented Interfaces:
WorkflowService
- Direct Known Subclasses:
BackofficeWorkflowService,DefaultCMSWorkflowService
Default implementation of
WorkflowService-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanassignUser(PrincipalModel principalModel, WorkflowModel workflowModel) Assigns principal to workflow.booleancanBeStarted(WorkflowModel workf) Checks if workflow can be startedcreateAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd, UserModel owner) Creates adhoc workflow with a name and adds an attachment to it.createWorkflow(WorkflowTemplateModel template, ItemModel attachmentItem, UserModel owner) Creates workflow based on a template and adds an attachment to it.createWorkflow(WorkflowTemplateModel template, UserModel owner) Creates workflow based on a template.createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd, UserModel owner) Creates workflow based on a template and adds an attachment to it.getAllAdhocWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date adhocDateFrom, Date adhocDateTo) Returns addhoc workflows that match statuses and time range.getAllAdhocWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date adhocDateFrom, Date adhocDateTo, int startIndex, int pageSize) Pageable version of methodWorkflowService.getAllAdhocWorkflows(EnumSet, Date, Date)getAllWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date dateFrom, Date dateTo) Returns workflows that match statuses and time range.getAllWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date dateFrom, Date dateTo, int startIndex, int pageSize) Pageable version of methodWorkflowService.getAllWorkflows(EnumSet, Date, Date)getStartTime(WorkflowModel workflow) Gets start time from a workflowprotected WorkflowActionModelgetWorkAction(WorkflowActionTemplateModel templateAction, List<WorkflowActionModel> workflowActions) getWorkflowForCode(String code) Returns workflow for a given codegetWorkflowsForTemplateAndUser(WorkflowTemplateModel template, UserModel user) Returns workflows that was created from giventemplatewhom owner is givenuser.booleanisAdhocWorkflow(WorkflowModel workflowModel) Checks if workflow is adhocbooleanisCompleted(WorkflowModel workflowModel) Checks if workflow is completedbooleanisFinished(WorkflowModel workflowModel) Checks if workflow is finishedbooleanisPaused(WorkflowModel workflowModel) Checks if workflow is pausedbooleanisPlanned(WorkflowModel workflowModel) Checks if workflow is plannedbooleanisRunning(WorkflowModel workflowModel) Checks if workflow is runningbooleanisTerminated(WorkflowModel workflowModel) Checks if workflow is terminatedvoidsetActionsWorkflowTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowTemplateModel, List<WorkflowActionModel>> actionsFromWorkflowTemplate) voidsetDecisionsActionTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowActionTemplateModel, List<WorkflowDecisionModel>> decisionsFromActionTemplate) voidsetModelService(ModelService modelService) voidsetPredecessorsActionTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowActionTemplateModel, List<AbstractWorkflowActionModel>> predecessorsFromActionTemplate) voidsetWorkflowActionService(WorkflowActionService workflowActionService) voidsetWorkflowDao(WorkflowDao workflowDao) voidsetWorkflowTemplateService(WorkflowTemplateService workflowTemplateService) booleanunassignUser(WorkflowModel workflowModel) Unassigns principal from workflow and assign dummy uservoidwriteAutomatedComment(WorkflowActionModel action, String message, String... messageParams)
-
Constructor Details
-
DefaultWorkflowService
public DefaultWorkflowService()
-
-
Method Details
-
setActionsWorkflowTemplateFactory
public void setActionsWorkflowTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowTemplateModel, List<WorkflowActionModel>> actionsFromWorkflowTemplate) -
setDecisionsActionTemplateFactory
public void setDecisionsActionTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowActionTemplateModel, List<WorkflowDecisionModel>> decisionsFromActionTemplate) -
setPredecessorsActionTemplateFactory
public void setPredecessorsActionTemplateFactory(WorkflowFactory<WorkflowModel, WorkflowActionTemplateModel, List<AbstractWorkflowActionModel>> predecessorsFromActionTemplate) -
getWorkflowsForTemplateAndUser
public List<WorkflowModel> getWorkflowsForTemplateAndUser(WorkflowTemplateModel template, UserModel user) Description copied from interface:WorkflowServiceReturns workflows that was created from giventemplatewhom owner is givenuser.- Specified by:
getWorkflowsForTemplateAndUserin interfaceWorkflowService- Parameters:
template- to be matcheduser- owner of the workflow
-
isTerminated
Description copied from interface:WorkflowServiceChecks if workflow is terminated- Specified by:
isTerminatedin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if terminated, false otherwise
-
createWorkflow
public WorkflowModel createWorkflow(WorkflowTemplateModel template, ItemModel attachmentItem, UserModel owner) Description copied from interface:WorkflowServiceCreates 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:
createWorkflowin interfaceWorkflowService- Parameters:
template- from which workflow is being createdattachmentItem- to be added- Returns:
- created workflow
-
createWorkflow
public WorkflowModel createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd, UserModel owner) Description copied from interface:WorkflowServiceCreates 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:
createWorkflowin interfaceWorkflowService- Parameters:
workflowName- name of a workflowtemplate- from which workflow is being createditemsToAdd- attachment items to be added- Returns:
- created workflow
-
createWorkflow
Description copied from interface:WorkflowServiceCreates workflow based on a template. It does not save workflow and actions, please do it by yourself.- Specified by:
createWorkflowin interfaceWorkflowService- Parameters:
template- from which workflow is being createdowner- of the workflow- Returns:
- created workflow
-
getAllWorkflows
public List<WorkflowModel> getAllWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date dateFrom, Date dateTo) Description copied from interface:WorkflowServiceReturns workflows that match statuses and time range. Workflow meets the time range when itsItemModel.getModifiedtime()is between givenadhocDateFromandadhocDateTo.- Specified by:
getAllWorkflowsin interfaceWorkflowService- Parameters:
workflowsStatuses- statuses to be matchdateFrom- time range startdateTo- time range end- Returns:
- workflows that match critetia
-
getAllAdhocWorkflows
public List<WorkflowModel> getAllAdhocWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date adhocDateFrom, Date adhocDateTo) Description copied from interface:WorkflowServiceReturns addhoc workflows that match statuses and time range. Workflow meets the time range when itsItemModel.getModifiedtime()is between givenadhocDateFromandadhocDateTo.- Specified by:
getAllAdhocWorkflowsin interfaceWorkflowService- Parameters:
workflowsStatuses- statuses to be matchadhocDateFrom- time range startadhocDateTo- time range end- Returns:
- adhoc workflows that match critetia
-
getAllWorkflows
public SearchResult<WorkflowModel> getAllWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date dateFrom, Date dateTo, int startIndex, int pageSize) Description copied from interface:WorkflowServicePageable version of methodWorkflowService.getAllWorkflows(EnumSet, Date, Date)- Specified by:
getAllWorkflowsin interfaceWorkflowService
-
getAllAdhocWorkflows
public SearchResult<WorkflowModel> getAllAdhocWorkflows(EnumSet<WorkflowStatus> workflowsStatuses, Date adhocDateFrom, Date adhocDateTo, int startIndex, int pageSize) Description copied from interface:WorkflowServicePageable version of methodWorkflowService.getAllAdhocWorkflows(EnumSet, Date, Date)- Specified by:
getAllAdhocWorkflowsin interfaceWorkflowService
-
isPlanned
Description copied from interface:WorkflowServiceChecks if workflow is planned- Specified by:
isPlannedin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if planned, false otherwise
-
isRunning
Description copied from interface:WorkflowServiceChecks if workflow is running- Specified by:
isRunningin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if running, false otherwise
-
isFinished
Description copied from interface:WorkflowServiceChecks if workflow is finished- Specified by:
isFinishedin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if planned, false otherwise
-
isPaused
Description copied from interface:WorkflowServiceChecks if workflow is paused- Specified by:
isPausedin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if paused, false otherwise
-
isCompleted
Description copied from interface:WorkflowServiceChecks if workflow is completed- Specified by:
isCompletedin interfaceWorkflowService- Parameters:
workflowModel- to check- Returns:
- true if completed, false otherwise
-
getWorkAction
protected WorkflowActionModel getWorkAction(WorkflowActionTemplateModel templateAction, List<WorkflowActionModel> workflowActions) -
writeAutomatedComment
public void writeAutomatedComment(WorkflowActionModel action, String message, String... messageParams) -
isAdhocWorkflow
Description copied from interface:WorkflowServiceChecks if workflow is adhoc- Specified by:
isAdhocWorkflowin interfaceWorkflowService- Parameters:
workflowModel- to check
-
canBeStarted
Description copied from interface:WorkflowServiceChecks if workflow can be started- Specified by:
canBeStartedin interfaceWorkflowService- Parameters:
workf- to check- Returns:
- true if can be started, false otherwise
-
getStartTime
Description copied from interface:WorkflowServiceGets start time from a workflow- Specified by:
getStartTimein interfaceWorkflowService- Returns:
- start date of workflow
-
createAdhocWorkflow
public WorkflowModel createAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd, UserModel owner) Description copied from interface:WorkflowServiceCreates adhoc workflow with a name and adds an attachment to it. This method does not save workflow, do it by yourself.- Specified by:
createAdhocWorkflowin interfaceWorkflowService- Parameters:
defaultName- name of a workflowitemsToAdd- attachment items to be addedowner- of the workflow- Returns:
- created workflow
-
assignUser
Description copied from interface:WorkflowServiceAssigns principal to workflow. This action does not save workflow, please do it by yourself.- Specified by:
assignUserin interfaceWorkflowService- Parameters:
principalModel- to be assigned to workflow
-
unassignUser
Description copied from interface:WorkflowServiceUnassigns principal from workflow and assign dummy user- Specified by:
unassignUserin interfaceWorkflowService
-
getWorkflowForCode
Description copied from interface:WorkflowServiceReturns workflow for a given code- Specified by:
getWorkflowForCodein interfaceWorkflowService
-
setModelService
- Parameters:
modelService- the modelService to set
-
setWorkflowActionService
- Parameters:
workflowActionService- the workflowActionService to set
-
setWorkflowDao
- Parameters:
workflowDao- the workflowDao to set
-
setWorkflowTemplateService
- Parameters:
workflowTemplateService- the workflowTemplateService to set
-