Package com.hybris.backoffice.workflow.impl

Class DefaultCoreWorkflowFacade

java.lang.Object

com.hybris.backoffice.workflow.impl.DefaultCoreWorkflowFacade

All Implemented Interfaces:

CoreWorkflowFacade

Direct Known Subclasses:

DefaultWorkflowFacade

public class DefaultCoreWorkflowFacade
extends java.lang.Object
implements CoreWorkflowFacade

Default implementation of facade to handle core workflow functionality (independent of the web context)

Constructor Summary

Constructors

Constructor	Description
DefaultCoreWorkflowFacade()

Method Summary

Modifier and Type	Method	Description
java.util.List<WorkflowItemAttachmentModel>	addItems(WorkflowModel workflow, java.util.List<? extends ItemModel> itemsToAdd)	Adds items to workflow as an attachment
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.
WorkflowModel	createWorkflow(java.lang.String name, WorkflowTemplateModel template, java.util.List<ItemModel> itemsToAdd, UserModel owner)	Creates an instance of WorkflowModel with given name, template, attached items and user.
WorkflowTemplateModel	getAdHocWorkflowTemplate()	Gets adHoc workflow template defined for the system.
java.util.List<WorkflowActionModel>	getCurrentTasks(WorkflowModel workflowModel)	Gets all WorkflowAction items with status WorkflowActionStatus.IN_PROGRESS.
WorkflowAttachmentService	getWorkflowAttachmentService()
WorkflowProcessingService	getWorkflowProcessingService()
WorkflowService	getWorkflowService()
java.util.Date	getWorkflowStartTime(WorkflowModel workflow)	Returns start time of given workflow.
WorkflowStatus	getWorkflowStatus(WorkflowModel workflowModel)	Checks WorkflowStatus of workflow model
WorkflowTemplateModel	getWorkflowTemplateForCode(java.lang.String code)	Loads WorkflowTemplateModel by given code.
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	removeItems(WorkflowModel workflow, java.util.List<WorkflowItemAttachmentModel> itemsToRemove)	Removes attachments from a workflow
void	setWorkflowAttachmentService(WorkflowAttachmentService workflowAttachmentService)
void	setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)
void	setWorkflowService(WorkflowService workflowService)
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

Constructor Detail

DefaultCoreWorkflowFacade

public DefaultCoreWorkflowFacade()

Method Detail

addItems

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

Description copied from interface: CoreWorkflowFacade

Adds items to workflow as an attachment

Specified by:

addItems in interface CoreWorkflowFacade

Parameters:

workflow - to which items should be added

itemsToAdd - items to add

Returns:

attachments

removeItems

public void removeItems(WorkflowModel workflow,
                        java.util.List<WorkflowItemAttachmentModel> itemsToRemove)

Description copied from interface: CoreWorkflowFacade

Removes attachments from a workflow

Specified by:

removeItems in interface CoreWorkflowFacade

Parameters:

workflow - WorkflowModel which contains given attachments

itemsToRemove - WorkflowItemAttachmentModels to remove

getWorkflowTemplateForCode

public WorkflowTemplateModel getWorkflowTemplateForCode(java.lang.String code)

Description copied from interface: CoreWorkflowFacade

Loads WorkflowTemplateModel by given code.

Specified by:

getWorkflowTemplateForCode in interface CoreWorkflowFacade

Parameters:

code - code of the WorkflowTemplateModel to be loaded

Returns:

WorkflowTemplateModel instance or null if the implementation cannot find appropriate WorkflowTemplateModel

getAdHocWorkflowTemplate

public WorkflowTemplateModel getAdHocWorkflowTemplate()

Description copied from interface: CoreWorkflowFacade

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

Specified by:

getAdHocWorkflowTemplate in interface CoreWorkflowFacade

Returns:

adHoc workflow template.

createWorkflow

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

Description copied from interface: CoreWorkflowFacade

Creates an instance of WorkflowModel with given name, template, attached items and user.

Specified by:

createWorkflow in interface CoreWorkflowFacade

Parameters:

name - name of the workflow

template - WorkflowTemplateModel to be used

itemsToAdd - item to be added to the workflow

owner - owner of the workflow

Returns:

WorkflowModel based on the given arguments

startWorkflow

public boolean startWorkflow(WorkflowModel workflow)

Description copied from interface: CoreWorkflowFacade

Starts given workflow

Specified by:

startWorkflow in interface CoreWorkflowFacade

Parameters:

workflow - workflow to start

Returns:

true if workflow has been started.

canBeStarted

public boolean canBeStarted(WorkflowModel workflow)

Description copied from interface: CoreWorkflowFacade

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

Specified by:

canBeStarted in interface CoreWorkflowFacade

Parameters:

workflow - workflow to be started

Returns:

true if workflow can be started.

isAdHocTemplate

public boolean isAdHocTemplate(WorkflowTemplateModel template)

Description copied from interface: CoreWorkflowFacade

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

Specified by:

isAdHocTemplate in interface CoreWorkflowFacade

Parameters:

template - template to be checked.

Returns:

true if the template is adHocTemplate.

isCorrectAdHocAssignee

public boolean isCorrectAdHocAssignee(PrincipalModel adHocAssignedUser)

Description copied from interface: CoreWorkflowFacade

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

Specified by:

isCorrectAdHocAssignee in interface CoreWorkflowFacade

Parameters:

adHocAssignedUser - user to be verified if can be assigned to an adHoc template

Returns:

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

getWorkflowStatus

public WorkflowStatus getWorkflowStatus(WorkflowModel workflowModel)

Description copied from interface: CoreWorkflowFacade

Checks WorkflowStatus of workflow model

Specified by:

getWorkflowStatus in interface CoreWorkflowFacade

Parameters:

workflowModel - model of workflow

Returns:

status of workflow or null if it was impossible to determine

terminateWorkflow

public boolean terminateWorkflow(WorkflowModel workflow)

Description copied from interface: CoreWorkflowFacade

Terminates given workflow

Specified by:

terminateWorkflow in interface CoreWorkflowFacade

Parameters:

workflow - workflow to terminate

Returns:

true if workflow has been terminated.

getCurrentTasks

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

Description copied from interface: CoreWorkflowFacade

Gets all WorkflowAction items with status WorkflowActionStatus.IN_PROGRESS.

Specified by:

getCurrentTasks in interface CoreWorkflowFacade

Parameters:

workflowModel - workflow to check.

Returns:

all WorkflowAction items in progress.

countDecisions

public int countDecisions(WorkflowModel workflowModel)

Description copied from interface: CoreWorkflowFacade

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

Specified by:

countDecisions in interface CoreWorkflowFacade

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: CoreWorkflowFacade

Returns start time of given workflow.

Specified by:

getWorkflowStartTime in interface CoreWorkflowFacade

Parameters:

workflow - workflow to check.

Returns:

start time of given workflow.

getWorkflowAttachmentService

public WorkflowAttachmentService getWorkflowAttachmentService()

setWorkflowAttachmentService

public void setWorkflowAttachmentService(WorkflowAttachmentService workflowAttachmentService)

getWorkflowTemplateService

public WorkflowTemplateService getWorkflowTemplateService()

setWorkflowTemplateService

public void setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)

getWorkflowService

public WorkflowService getWorkflowService()

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

getWorkflowProcessingService

public WorkflowProcessingService getWorkflowProcessingService()

setWorkflowProcessingService

public void setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)