Package de.hybris.platform.cms2.workflow.service.impl

Class DefaultCMSWorkflowService

java.lang.Object

de.hybris.platform.workflow.impl.DefaultWorkflowService

de.hybris.platform.cms2.workflow.service.impl.DefaultCMSWorkflowService

All Implemented Interfaces:

CMSWorkflowService, WorkflowService

public class DefaultCMSWorkflowService
extends DefaultWorkflowService
implements CMSWorkflowService

Default implementation of the CMSWorkflowService.

Constructor Summary

Constructors

Constructor	Description
DefaultCMSWorkflowService()

Method Summary

Modifier and Type	Method	Description
List<WorkflowModel>	findAllWorkflowsByAttachedItems(List<? extends CMSItemModel> items, Set<CronJobStatus> statuses)	This method finds all WorkflowModel, with the specified workflow statuses, to which the given items are attached to.
SearchResult<WorkflowModel>	findWorkflowsForAttachedItemsAndStatuses(List<? extends CMSItemModel> items, Set<CronJobStatus> statuses, PageableData pageableData)	This is the pageable version of CMSWorkflowService.findAllWorkflowsByAttachedItems(List, Set) This method finds all WorkflowModel, with the specified workflow statuses, to which the given items are attached to.
protected CMSWorkflowDao	getCmsWorkflowDao()
protected CMSWorkflowParticipantService	getCmsWorkflowParticipantService()
protected RelatedItemsService	getRelatedItemsService()
List<WorkflowModel>	getRelatedWorkflowsForItem(CMSItemModel item, Set<CronJobStatus> statuses)	This method returns a list of related workflows for an item.
Optional<WorkflowModel>	getWorkflowWhereItemEditable(CMSItemModel item)	Returns a workflow where provided CMSItemModel is editable.
boolean	isAnyItemInWorkflow(List<? extends CMSItemModel> itemUids)	This method checks if any of the provided CmsItems are already part of an active (RUNNING or PAUSED) workflow.
boolean	isItemEditableBySessionUser(CMSItemModel item)	This method verifies whether the item model can be edited by session user.
void	setCmsWorkflowDao(CMSWorkflowDao cmsWorkflowDao)
void	setCmsWorkflowParticipantService(CMSWorkflowParticipantService cmsWorkflowParticipantService)
void	setRelatedItemsService(RelatedItemsService relatedItemsService)

Methods inherited from class de.hybris.platform.workflow.impl.DefaultWorkflowService

assignUser, canBeStarted, createAdhocWorkflow, createWorkflow, createWorkflow, createWorkflow, getAllAdhocWorkflows, getAllAdhocWorkflows, getAllWorkflows, getAllWorkflows, getStartTime, getWorkAction, getWorkflowForCode, getWorkflowsForTemplateAndUser, isAdhocWorkflow, isCompleted, isFinished, isPaused, isPlanned, isRunning, isTerminated, setActionsWorkflowTemplateFactory, setDecisionsActionTemplateFactory, setModelService, setPredecessorsActionTemplateFactory, setWorkflowActionService, setWorkflowDao, setWorkflowTemplateService, unassignUser, writeAutomatedComment

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.workflow.WorkflowService

assignUser, canBeStarted, createAdhocWorkflow, createWorkflow, createWorkflow, createWorkflow, getAllAdhocWorkflows, getAllAdhocWorkflows, getAllWorkflows, getAllWorkflows, getStartTime, getWorkflowForCode, getWorkflowsForTemplateAndUser, isAdhocWorkflow, isCompleted, isFinished, isPaused, isPlanned, isRunning, isTerminated, unassignUser

Constructor Details

DefaultCMSWorkflowService

public DefaultCMSWorkflowService()

Method Details

isAnyItemInWorkflow

public boolean isAnyItemInWorkflow(List<? extends CMSItemModel> itemUids)

Description copied from interface: CMSWorkflowService

This method checks if any of the provided CmsItems are already part of an active (RUNNING or PAUSED) workflow.

Specified by:

isAnyItemInWorkflow in interface CMSWorkflowService

Parameters:

itemUids - - The uids of the CmsItems to check if they are part of an active workflow.

Returns:

True if any of the given CmsItems is part of an active workflow. False, otherwise.

findWorkflowsForAttachedItemsAndStatuses

public SearchResult<WorkflowModel> findWorkflowsForAttachedItemsAndStatuses(List<? extends CMSItemModel> items,
 Set<CronJobStatus> statuses,
 PageableData pageableData)

Description copied from interface: CMSWorkflowService

This is the pageable version of CMSWorkflowService.findAllWorkflowsByAttachedItems(List, Set)
This method finds all WorkflowModel, with the specified workflow statuses, to which the given items are attached to. If the items are not attached to any workflow, the list will be empty.

Specified by:

findWorkflowsForAttachedItemsAndStatuses in interface CMSWorkflowService

Parameters:

items - - the CMS Items for which to find the workflows they are attached to.

statuses - - the workflow statuses

pageableData - - the pagination object used to set the page index and page size

Returns:

the search result object containing the resulting the list of WorkflowModel, in the specified statuses, to which the given pages are attached to and the pagination object; never null.

findAllWorkflowsByAttachedItems

public List<WorkflowModel> findAllWorkflowsByAttachedItems(List<? extends CMSItemModel> items,
 Set<CronJobStatus> statuses)

Description copied from interface: CMSWorkflowService

This method finds all WorkflowModel, with the specified workflow statuses, to which the given items are attached to. If the items are not attached to any workflow, the list will be empty.

Specified by:

findAllWorkflowsByAttachedItems in interface CMSWorkflowService

Parameters:

items - - the CMS Items for which to find the workflows they are attached to.

statuses - - the workflow statuses

Returns:

the list of WorkflowModel, in the specified statuses, to which the given pages are attached to; never null.

getRelatedWorkflowsForItem

public List<WorkflowModel> getRelatedWorkflowsForItem(CMSItemModel item,
 Set<CronJobStatus> statuses)

Description copied from interface: CMSWorkflowService

This method returns a list of related workflows for an item. The list is sorted by creationtime in ascending order.

Specified by:

getRelatedWorkflowsForItem in interface CMSWorkflowService

Parameters:

item - the CMSItemModel

statuses - the list of CronJobStatus statuses

Returns:

the list of WorkflowModel

isItemEditableBySessionUser

public boolean isItemEditableBySessionUser(CMSItemModel item)

Description copied from interface: CMSWorkflowService

This method verifies whether the item model can be edited by session user.

Specified by:

isItemEditableBySessionUser in interface CMSWorkflowService

Parameters:

item - the CMSItemModel to verify

Returns:

TRUE if the item model can be edited by session user, FALSE otherwise

getWorkflowWhereItemEditable

public Optional<WorkflowModel> getWorkflowWhereItemEditable(CMSItemModel item)

Description copied from interface: CMSWorkflowService

Returns a workflow where provided CMSItemModel is editable.

Specified by:

getWorkflowWhereItemEditable in interface CMSWorkflowService

Parameters:

item - the CMSItemModel to verify

Returns:

the optional WorkflowModel

getCmsWorkflowDao

protected CMSWorkflowDao getCmsWorkflowDao()

setCmsWorkflowDao

public void setCmsWorkflowDao(CMSWorkflowDao cmsWorkflowDao)

getRelatedItemsService

protected RelatedItemsService getRelatedItemsService()

setRelatedItemsService

public void setRelatedItemsService(RelatedItemsService relatedItemsService)

getCmsWorkflowParticipantService

protected CMSWorkflowParticipantService getCmsWorkflowParticipantService()

setCmsWorkflowParticipantService

public void setCmsWorkflowParticipantService(CMSWorkflowParticipantService cmsWorkflowParticipantService)