com.hybris.backoffice.workflow

Interface WorkflowFacade

All Known Implementing Classes:

DefaultWorkflowFacade

public interface WorkflowFacade

Facade used to fetch WorkflowModels.

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
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.
java.util.List<WorkflowActionModel>	getWorkflowActions() Gets workflow actions for the current user.
<any>	getWorkflows(WorkflowSearchData workflowSearchData) Gets workflows based on given search data.
java.util.Date	getWorkflowStartTime(WorkflowModel workflow) Returns start time of given workflow.
WorkflowStatus	getWorkflowStatus(WorkflowModel workflowModel) Checks WorkflowStatus of workflow model
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.
boolean	startWorkflow(WorkflowModel workflow) Starts given workflow
boolean	terminateWorkflow(WorkflowModel workflow) Terminates given workflow

Method Detail

getWorkflows

<any> getWorkflows(WorkflowSearchData workflowSearchData)

Gets workflows based on given search data.

Parameters:

workflowSearchData - search data which allows to specify search criteria.

Returns:

pageable with workflows Pageable

getWorkflowActions

java.util.List<WorkflowActionModel> getWorkflowActions()

Gets workflow actions for the current user.

Returns:

workflow actions.

addItems

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

Adds items to workflow as an attachment

Parameters:

workflow - to which items should be added

itemsToAdd - items to add

Returns:

attachments

getAllVisibleWorkflowTemplatesForCurrentUser

java.util.List<WorkflowTemplateModel> getAllVisibleWorkflowTemplatesForCurrentUser()

Gets workflow templates visible for current user.

Returns:

list of workflow templates

getAdHocWorkflowTemplate

WorkflowTemplateModel getAdHocWorkflowTemplate()

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

Returns:

adHoc workflow template.

createWorkflow

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.

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

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.

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.

startWorkflow

boolean startWorkflow(WorkflowModel workflow)

Starts given workflow

Parameters:

workflow - workflow to start

Returns:

true if workflow has been started.

canBeStarted

boolean canBeStarted(WorkflowModel workflow)

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

Parameters:

workflow - workflow to be started

Returns:

true if workflow can be started.

isAdHocTemplate

boolean isAdHocTemplate(WorkflowTemplateModel template)

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

Parameters:

template - template to be checked.

Returns:

true if the template is adHocTemplate.

isCorrectAdHocAssignee

boolean isCorrectAdHocAssignee(PrincipalModel adHocAssignedUser)

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

Parameters:

adHocAssignedUser -

Returns:

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

getWorkflowStatus

WorkflowStatus getWorkflowStatus(WorkflowModel workflowModel)

Checks WorkflowStatus of workflow model

Parameters:

workflowModel - model of workflow

Returns:

status of workflow or null if it was impossible to determine

deleteWorkflow

void deleteWorkflow(WorkflowModel workflow)
             throws ObjectDeletionException

Deletes given workflow

Parameters:

workflow - workflow to delete

Throws:

ObjectDeletionException

terminateWorkflow

boolean terminateWorkflow(WorkflowModel workflow)

Terminates given workflow

Parameters:

workflow - workflow to terminate

Returns:

true if workflow has been terminated.

getCurrentTasks

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

Gets all WorkflowAction items with status WorkflowActionStatus.IN_PROGRESS.

Parameters:

workflowModel - workflow to check.

Returns:

all WorkflowAction items in progress.

countDecisions

int countDecisions(WorkflowModel workflowModel)

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

Parameters:

workflowModel - workflow to check.

Returns:

all decisions to make in all actions of the workflow

getWorkflowStartTime

java.util.Date getWorkflowStartTime(WorkflowModel workflow)

Returns start time of given workflow.

Parameters:

workflow - workflow to check.

Returns:

start time of given workflow.