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

Interface CMSWorkflowActionService

All Superinterfaces:

WorkflowActionService

All Known Implementing Classes:

DefaultCMSWorkflowActionService

public interface CMSWorkflowActionService
extends WorkflowActionService

Service to manage workflow actions and decisions.

Method Summary

Modifier and Type	Method	Description
SearchResult<WorkflowActionModel>	findAllActiveWorkflowActionsByStatusAndPrincipals(java.util.Set<CronJobStatus> workflowStatuses, java.util.Collection<PrincipalModel> currentPrincipals, PageableData pageableData)	This method finds all the active WorkflowActionModel of AbstractPageModel attachment types for the given principals and specified workflow statuses.
WorkflowDecisionModel	getActionDecisionForCode(WorkflowActionModel action, java.lang.String decisionCode)	Finds the WorkflowDecisionModel for a given WorkflowActionModel that matches the provided decision code.
WorkflowActionModel	getWorkflowActionForCode(WorkflowModel workflow, java.lang.String actionCode)	Finds the WorkflowActionModel for a given WorkflowModel that matches the provided action code.

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

complete, createWorkflowAction, disable, getActionForCode, getAllUserWorkflowActionsWithAttachment, getAllUserWorkflowActionsWithAttachment, getAllUserWorkflowActionsWithAttachments, getAllUserWorkflowActionsWithAttachments, getEndWorkflowActions, getNormalWorkflowActions, getStartWorkflowActions, getWorkflowActionsByType, idle, isActive, isCompleted, isDisabled, isEndedByWorkflow, isUserAssignedPrincipal

Method Detail

getWorkflowActionForCode

WorkflowActionModel getWorkflowActionForCode(WorkflowModel workflow,
                                             java.lang.String actionCode)

Finds the WorkflowActionModel for a given WorkflowModel that matches the provided action code.

Parameters:

workflow - - the WorkflowModel

actionCode - - the action code

Returns:

the WorkflowActionModel

getActionDecisionForCode

WorkflowDecisionModel getActionDecisionForCode(WorkflowActionModel action,
                                               java.lang.String decisionCode)

Finds the WorkflowDecisionModel for a given WorkflowActionModel that matches the provided decision code.

Parameters:

action - - the WorkflowActionModel

decisionCode - - the decision code

Returns:

the WorkflowDecisionModel

findAllActiveWorkflowActionsByStatusAndPrincipals

SearchResult<WorkflowActionModel> findAllActiveWorkflowActionsByStatusAndPrincipals(java.util.Set<CronJobStatus> workflowStatuses,
                                                                                    java.util.Collection<PrincipalModel> currentPrincipals,
                                                                                    PageableData pageableData)

This method finds all the active WorkflowActionModel of AbstractPageModel attachment types for the given principals and specified workflow statuses.

Parameters:

workflowStatuses - - the workflow statuses used to filter the result

currentPrincipals - - the principals for which to find the workflow actions that have active workflow actions to be acted upon.

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

Returns:

the search result object containing the resulting list of WorkflowActionModel and the pagination object.