com.hybris.backoffice.workflow.impl

Class DefaultWorkflowFacade

java.lang.Object

com.hybris.backoffice.workflow.impl.DefaultWorkflowFacade

All Implemented Interfaces:

WorkflowFacade

public class DefaultWorkflowFacade
extends java.lang.Object
implements WorkflowFacade

Default implementation of the WorkflowFacade.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AD_HOC_WORKFLOW_DUMMY_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultWorkflowFacade()

Method Summary

Modifier and Type	Method and Description
java.util.List<WorkflowItemAttachmentModel>	addItems(WorkflowModel workflow, java.util.List<? extends ItemModel> itemsToAdd) Adds items to workflow as an attachment
protected java.util.List<ItemModel>	assureAttachmentsWithoutDuplicates(java.util.List<ItemModel> attachments)
boolean	canBeStarted(WorkflowModel workflow) Tells if workflow can be started - has assigned users to all actions etc.
int	countDecisions(WorkflowModel workflowModel) Counts all decisions to make in all actions of the workflow.
java.util.Optional<WorkflowModel>	createAdHocWorkflow(PrincipalModel assignee, java.util.Map<java.util.Locale,java.lang.String> localizedName, java.util.Map<java.util.Locale,java.lang.String> localizedDesc, java.util.List<ItemModel> attachments) Creates adHocWorkflow from given template for current user.
WorkflowModel	createWorkflow(WorkflowTemplateModel workflowTemplate, java.util.Map<java.util.Locale,java.lang.String> localizedName, java.util.Map<java.util.Locale,java.lang.String> localizedDesc, java.util.List<ItemModel> attachments) Creates workflow from given template for current user.
void	deleteWorkflow(WorkflowModel workflow) Deletes given workflow
WorkflowTemplateModel	getAdHocWorkflowTemplate() Gets adHoc workflow template defined for the system.
java.util.List<WorkflowTemplateModel>	getAllVisibleWorkflowTemplatesForCurrentUser() Gets workflow templates visible for current user.
java.util.List<WorkflowActionModel>	getCurrentTasks(WorkflowModel workflowModel) Gets all WorkflowAction items with status WorkflowActionStatus.IN_PROGRESS.
protected ModelService	getModelService()
ObjectFacade	getObjectFacade()
protected TypeFacade	getTypeFacade()
protected TypeService	getTypeService()
protected UserService	getUserService()
java.util.List<WorkflowActionModel>	getWorkflowActions() Gets workflow actions for the current user.
protected WorkflowActionService	getWorkflowActionService()
protected WorkflowAttachmentService	getWorkflowAttachmentService()
protected WorkflowProcessingService	getWorkflowProcessingService()
<any>	getWorkflows(WorkflowSearchData workflowSearchData) Gets workflows based on given search data.
protected WorkflowService	getWorkflowService()
java.util.Date	getWorkflowStartTime(WorkflowModel workflow) Returns start time of given workflow.
WorkflowStatus	getWorkflowStatus(WorkflowModel workflowModel) Checks WorkflowStatus of workflow model
protected WorkflowsTypeFacade	getWorkflowsTypeFacade()
protected WorkflowTemplateService	getWorkflowTemplateService()
boolean	isAdHocTemplate(WorkflowTemplateModel template) Tells is given template is adHocTemplate WorkflowService.isAdhocWorkflow(WorkflowModel).
boolean	isCorrectAdHocAssignee(PrincipalModel adHocAssignedUser) Tells if given principal can be assigned to a adHoc template.
void	setModelService(ModelService modelService)
void	setObjectFacade(ObjectFacade objectFacade)
void	setTypeFacade(TypeFacade typeFacade)
void	setTypeService(TypeService typeService)
void	setUserService(UserService userService)
void	setWorkflowActionService(WorkflowActionService workflowActionService)
void	setWorkflowAttachmentService(WorkflowAttachmentService workflowAttachmentService)
void	setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)
void	setWorkflowService(WorkflowService workflowService)
void	setWorkflowsTypeFacade(WorkflowsTypeFacade workflowsTypeFacade)
void	setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)
boolean	startWorkflow(WorkflowModel workflow) Starts given workflow
boolean	terminateWorkflow(WorkflowModel workflow) Terminates given workflow

Methods inherited from class java.lang.Object

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

Field Detail

AD_HOC_WORKFLOW_DUMMY_NAME

protected static final java.lang.String AD_HOC_WORKFLOW_DUMMY_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultWorkflowFacade

public DefaultWorkflowFacade()

Method Detail

getWorkflowActions

public java.util.List<WorkflowActionModel> getWorkflowActions()

Description copied from interface: WorkflowFacade

Gets workflow actions for the current user.

Specified by:

getWorkflowActions in interface WorkflowFacade

Returns:

workflow actions.

getWorkflows

public <any> getWorkflows(WorkflowSearchData workflowSearchData)

Description copied from interface: WorkflowFacade

Gets workflows based on given search data.

Specified by:

getWorkflows in interface WorkflowFacade

Parameters:

workflowSearchData - search data which allows to specify search criteria.

Returns:

pageable with workflows Pageable

getAllVisibleWorkflowTemplatesForCurrentUser

public java.util.List<WorkflowTemplateModel> getAllVisibleWorkflowTemplatesForCurrentUser()

Description copied from interface: WorkflowFacade

Gets workflow templates visible for current user.

Specified by:

getAllVisibleWorkflowTemplatesForCurrentUser in interface WorkflowFacade

Returns:

list of workflow templates

getAdHocWorkflowTemplate

public WorkflowTemplateModel getAdHocWorkflowTemplate()

Description copied from interface: WorkflowFacade

Gets adHoc workflow template defined for the system. WorkflowTemplateService.getAdhocWorkflowTemplate()

Specified by:

getAdHocWorkflowTemplate in interface WorkflowFacade

Returns:

adHoc workflow template.

createWorkflow

public WorkflowModel createWorkflow(WorkflowTemplateModel workflowTemplate,
                                    java.util.Map<java.util.Locale,java.lang.String> localizedName,
                                    java.util.Map<java.util.Locale,java.lang.String> localizedDesc,
                                    java.util.List<ItemModel> attachments)

Description copied from interface: WorkflowFacade

Creates workflow from given template for current user.

Specified by:

createWorkflow in interface WorkflowFacade

Parameters:

workflowTemplate - template to start.

localizedName - localized name.

localizedDesc - localized workflow description.

attachments - list of items to be attached to the workflow.

Returns:

created workflow.

createAdHocWorkflow

public java.util.Optional<WorkflowModel> createAdHocWorkflow(PrincipalModel assignee,
                                                             java.util.Map<java.util.Locale,java.lang.String> localizedName,
                                                             java.util.Map<java.util.Locale,java.lang.String> localizedDesc,
                                                             java.util.List<ItemModel> attachments)

Description copied from interface: WorkflowFacade

Creates adHocWorkflow from given template for current user.

Specified by:

createAdHocWorkflow in interface WorkflowFacade

Parameters:

assignee - adHocTemplate assignee.

localizedName - localized name.

localizedDesc - localized workflow description.

attachments - list of items to be attached to the workflow.

Returns:

if workflow is created with given assignee then it will return create workflow.

assureAttachmentsWithoutDuplicates

protected java.util.List<ItemModel> assureAttachmentsWithoutDuplicates(java.util.List<ItemModel> attachments)

startWorkflow

public boolean startWorkflow(WorkflowModel workflow)

Description copied from interface: WorkflowFacade

Starts given workflow

Specified by:

startWorkflow in interface WorkflowFacade

Parameters:

workflow - workflow to start

Returns:

true if workflow has been started.

canBeStarted

public boolean canBeStarted(WorkflowModel workflow)

Description copied from interface: WorkflowFacade

Tells if workflow can be started - has assigned users to all actions etc. WorkflowService.canBeStarted(WorkflowModel)

Specified by:

canBeStarted in interface WorkflowFacade

Parameters:

workflow - workflow to be started

Returns:

true if workflow can be started.

isAdHocTemplate

public boolean isAdHocTemplate(WorkflowTemplateModel template)

Description copied from interface: WorkflowFacade

Tells is given template is adHocTemplate WorkflowService.isAdhocWorkflow(WorkflowModel).

Specified by:

isAdHocTemplate in interface WorkflowFacade

Parameters:

template - template to be checked.

Returns:

true if the template is adHocTemplate.

isCorrectAdHocAssignee

public boolean isCorrectAdHocAssignee(PrincipalModel adHocAssignedUser)

Description copied from interface: WorkflowFacade

Tells if given principal can be assigned to a adHoc template. It cannot be WorkflowTemplateService.getAdhocWorkflowTemplateDummyOwner()

Specified by:

isCorrectAdHocAssignee in interface WorkflowFacade

Returns:

true if given principal can be assigned to a adHoc template.

addItems

public java.util.List<WorkflowItemAttachmentModel> addItems(WorkflowModel workflow,
                                                            java.util.List<? extends ItemModel> itemsToAdd)

Description copied from interface: WorkflowFacade

Adds items to workflow as an attachment

Specified by:

addItems in interface WorkflowFacade

Parameters:

workflow - to which items should be added

itemsToAdd - items to add

Returns:

attachments

deleteWorkflow

public void deleteWorkflow(WorkflowModel workflow)
                    throws ObjectDeletionException

Description copied from interface: WorkflowFacade

Deletes given workflow

Specified by:

deleteWorkflow in interface WorkflowFacade

Parameters:

workflow - workflow to delete

Throws:

ObjectDeletionException

terminateWorkflow

public boolean terminateWorkflow(WorkflowModel workflow)

Description copied from interface: WorkflowFacade

Terminates given workflow

Specified by:

terminateWorkflow in interface WorkflowFacade

Parameters:

workflow - workflow to terminate

Returns:

true if workflow has been terminated.

getWorkflowStatus

public WorkflowStatus getWorkflowStatus(WorkflowModel workflowModel)

Description copied from interface: WorkflowFacade

Checks WorkflowStatus of workflow model

Specified by:

getWorkflowStatus in interface WorkflowFacade

Parameters:

workflowModel - model of workflow

Returns:

status of workflow or null if it was impossible to determine

getCurrentTasks

public java.util.List<WorkflowActionModel> getCurrentTasks(WorkflowModel workflowModel)

Description copied from interface: WorkflowFacade

Gets all WorkflowAction items with status WorkflowActionStatus.IN_PROGRESS.

Specified by:

getCurrentTasks in interface WorkflowFacade

Parameters:

workflowModel - workflow to check.

Returns:

all WorkflowAction items in progress.

countDecisions

public int countDecisions(WorkflowModel workflowModel)

Description copied from interface: WorkflowFacade

Counts all decisions to make in all actions of the workflow.

Specified by:

countDecisions in interface WorkflowFacade

Parameters:

workflowModel - workflow to check.

Returns:

all decisions to make in all actions of the workflow

getWorkflowStartTime

public java.util.Date getWorkflowStartTime(WorkflowModel workflow)

Description copied from interface: WorkflowFacade

Returns start time of given workflow.

Specified by:

getWorkflowStartTime in interface WorkflowFacade

Parameters:

workflow - workflow to check.

Returns:

start time of given workflow.

getWorkflowTemplateService

protected WorkflowTemplateService getWorkflowTemplateService()

setWorkflowTemplateService

public void setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)

getWorkflowService

protected WorkflowService getWorkflowService()

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getWorkflowProcessingService

protected WorkflowProcessingService getWorkflowProcessingService()

setWorkflowProcessingService

public void setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)

getWorkflowAttachmentService

protected WorkflowAttachmentService getWorkflowAttachmentService()

setWorkflowAttachmentService

public void setWorkflowAttachmentService(WorkflowAttachmentService workflowAttachmentService)

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getWorkflowActionService

protected WorkflowActionService getWorkflowActionService()

setWorkflowActionService

public void setWorkflowActionService(WorkflowActionService workflowActionService)

getWorkflowsTypeFacade

protected WorkflowsTypeFacade getWorkflowsTypeFacade()

setWorkflowsTypeFacade

public void setWorkflowsTypeFacade(WorkflowsTypeFacade workflowsTypeFacade)

getObjectFacade

public ObjectFacade getObjectFacade()

setObjectFacade

public void setObjectFacade(ObjectFacade objectFacade)