Package de.hybris.platform.b2b.services

Interface B2BWorkflowIntegrationService

All Known Implementing Classes:

DefaultB2BWorkflowIntegrationService

public interface B2BWorkflowIntegrationService

A integration service for workflow and process engine.

Spring Bean ID:

b2bWorkflowIntegrationService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	B2BWorkflowIntegrationService.ACTIONCODES	The Enum ACTIONCODES.
static class	B2BWorkflowIntegrationService.DECISIONCODES	The Enum DECISIONCODES.

Method Summary

Modifier and Type	Method	Description
void	approveWorkflowAction(WorkflowActionModel workflowActionModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.
WorkflowModel	createWorkflow(WorkflowTemplateModel template, java.util.List<? extends ItemModel> attachments)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.
WorkflowTemplateModel	createWorkflowTemplate(java.util.List<? extends UserModel> users, java.lang.String code, java.lang.String description, WorkflowTemplateType templateType)	This will create a WorkflowTemplateModel if one does not exist
void	decideAction(WorkflowActionModel workflowActionModel, java.lang.String decisionQualifier)	Makes a decision on an action based on the qualifier (The qualifier is used to look up a decision with its code build from AbstractWorkflowActionModel.CODE_decisionQualifier)
java.util.Collection<WorkflowActionModel>	findByActionStatusAndUser(WorkflowActionStatus status, java.lang.String qualifier, UserModel user)	Deprecated, for removal: This API element is subject to removal in a future version. As of hybris 4.4, replaced by getWorkflowActionsForActionStatusAndUser(WorkflowActionStatus, String, UserModel)
WorkflowModel	findWorkflowForOrder(OrderModel order)	Deprecated, for removal: This API element is subject to removal in a future version. As of hybris 4.4, replaced by getWorkflowForOrder(OrderModel)
java.lang.String	generateWorkflowTemplateCode(java.lang.String prefix, java.util.List<? extends UserModel> users)	Generates a list of appended prefix_PrincipalModel.UID
WorkflowActionModel	getActionByCode(java.lang.String code)	Deprecated, for removal: This API element is subject to removal in a future version. As of hybris 4.4, replaced by getActionForCode(String)
WorkflowActionModel	getActionForCode(java.lang.String code)	Get WorkflowAction for its code.
OrderModel	getOrderFromAction(WorkflowActionModel workflowActionModel)	Gets the associated order to the WorkflowActionModel qualifier.
java.util.Collection<WorkflowActionModel>	getStartWorkflowActions(WorkflowModel workflow)	Gets all WorkFlowActions that are of WorkflowActionType.START type.
java.util.Collection<WorkflowActionModel>	getWorkflowActionsForActionStatusAndUser(WorkflowActionStatus status, java.lang.String qualifier, UserModel user)	Gets all WorkflowActions by user, workflowActionStatus (eg IN_PROGRESS) and qualifier (eg APPROVAL)
java.util.Collection<WorkflowActionModel>	getWorkflowActionsForUser(UserModel user)	Gets a collection of workflow actions for a user
WorkflowModel	getWorkflowForOrder(OrderModel order)	Get the Workflow for an Order.
WorkflowTemplateModel	getWorkflowTemplateForCode(java.lang.String code)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.
void	rejectWorkflowAction(WorkflowActionModel workflowActionModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.
void	startWorkflow(WorkflowModel workflowModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.

Method Detail

getStartWorkflowActions

java.util.Collection<WorkflowActionModel> getStartWorkflowActions(WorkflowModel workflow)

Gets all WorkFlowActions that are of WorkflowActionType.START type.

Parameters:

workflow - the WorkflowModel

Returns:

a list of WorkflowActionModels

getWorkflowTemplateForCode

@Deprecated(since="4.4",
            forRemoval=true)
WorkflowTemplateModel getWorkflowTemplateForCode(java.lang.String code)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.4. WorkflowTemplateService.getWorkflowTemplateForCode(String)

Gets the WorkflowTemplateModel based on the code.

Parameters:

code - the WorkflowActionType code

Returns:

WorkflowTemplateModel

createWorkflowTemplate

WorkflowTemplateModel createWorkflowTemplate(java.util.List<? extends UserModel> users,
                                             java.lang.String code,
                                             java.lang.String description,
                                             WorkflowTemplateType templateType)

This will create a WorkflowTemplateModel if one does not exist

Parameters:

users - the approvers that a work flow template will be created for

code - the code of the template

description - the short description for the template

templateType - the strategy type of the template

Returns:

newly created WorkflowTemplateModel

generateWorkflowTemplateCode

java.lang.String generateWorkflowTemplateCode(java.lang.String prefix,
                                              java.util.List<? extends UserModel> users)

Generates a list of appended prefix_PrincipalModel.UID

Parameters:

prefix - the String to which the user id is appended to

users - the list of users in which the template code will be generated for

Returns:

the template code of appended values

createWorkflow

@Deprecated(since="4.4",
            forRemoval=true)
WorkflowModel createWorkflow(WorkflowTemplateModel template,
                             java.util.List<? extends ItemModel> attachments)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.4. Use WorkflowService.createWorkflow(String, de.hybris.platform.workflow.model.WorkflowTemplateModel, java.util.List, de.hybris.platform.core.model.user.UserModel)

Parameters:

template - the workflow template

attachments - the workflow attachments

Returns:

the workflow

startWorkflow

@Deprecated(since="4.4",
            forRemoval=true)
void startWorkflow(WorkflowModel workflowModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.4. Use WorkflowProcessingService.startWorkflow(de.hybris.platform.workflow.model.WorkflowModel)

Parameters:

workflowModel -

findByActionStatusAndUser

@Deprecated(since="4.4",
            forRemoval=true)
java.util.Collection<WorkflowActionModel> findByActionStatusAndUser(WorkflowActionStatus status,
                                                                    java.lang.String qualifier,
                                                                    UserModel user)

Deprecated, for removal: This API element is subject to removal in a future version.

As of hybris 4.4, replaced by getWorkflowActionsForActionStatusAndUser(WorkflowActionStatus, String, UserModel)

Parameters:

status - the action status

qualifier - the qualifier

user - the assigned user

Returns:

the Collection of {WorkflowActionModel}

getWorkflowActionsForActionStatusAndUser

java.util.Collection<WorkflowActionModel> getWorkflowActionsForActionStatusAndUser(WorkflowActionStatus status,
                                                                                   java.lang.String qualifier,
                                                                                   UserModel user)

Gets all WorkflowActions by user, workflowActionStatus (eg IN_PROGRESS) and qualifier (eg APPROVAL)

Parameters:

status - the work flow action status

qualifier - the qualifier (eg APPROVAL)

user - the user

Returns:

WorkflowActionModel the set of work flow actions

getOrderFromAction

OrderModel getOrderFromAction(WorkflowActionModel workflowActionModel)

Gets the associated order to the WorkflowActionModel qualifier. The qualifier's attachment of type B2BApprovalProcessModel will have the associated order.

Parameters:

workflowActionModel - the work flow action

Returns:

the order associated to the attachment

rejectWorkflowAction

@Deprecated(since="4.4",
            forRemoval=true)
void rejectWorkflowAction(WorkflowActionModel workflowActionModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.4. Use decideAction(de.hybris.platform.workflow.model.WorkflowActionModel, String) decideAction(action, DECISIONCODES.REJECT.name())

Parameters:

workflowActionModel -

approveWorkflowAction

@Deprecated(since="4.4",
            forRemoval=true)
void approveWorkflowAction(WorkflowActionModel workflowActionModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.4. Use decideAction(de.hybris.platform.workflow.model.WorkflowActionModel, String) decideAction(action, DECISIONCODES.APPROVE.name())

Parameters:

workflowActionModel -

getActionByCode

@Deprecated(since="4.4",
            forRemoval=true)
WorkflowActionModel getActionByCode(java.lang.String code)

Deprecated, for removal: This API element is subject to removal in a future version.

As of hybris 4.4, replaced by getActionForCode(String)

Parameters:

code - the action code

Returns:

the workflow action

getActionForCode

WorkflowActionModel getActionForCode(java.lang.String code)

Get WorkflowAction for its code.

Parameters:

code - the WorkflowAction's code

Returns:

WorkflowActionModel

findWorkflowForOrder

@Deprecated(since="4.4",
            forRemoval=true)
WorkflowModel findWorkflowForOrder(OrderModel order)

Deprecated, for removal: This API element is subject to removal in a future version.

As of hybris 4.4, replaced by getWorkflowForOrder(OrderModel)

Parameters:

order - the order for which to find the workflow

Returns:

the order WorkflowModel

getWorkflowForOrder

WorkflowModel getWorkflowForOrder(OrderModel order)

Get the Workflow for an Order.

Parameters:

order - the order

Returns:

WorkflowModel

decideAction

void decideAction(WorkflowActionModel workflowActionModel,
                  java.lang.String decisionQualifier)

Makes a decision on an action based on the qualifier (The qualifier is used to look up a decision with its code build from AbstractWorkflowActionModel.CODE_decisionQualifier)

Parameters:

workflowActionModel - The action to make a decision upon

decisionQualifier - a qualifier based on B2BWorkflowIntegrationService.DECISIONCODES enumeration

getWorkflowActionsForUser

java.util.Collection<WorkflowActionModel> getWorkflowActionsForUser(UserModel user)

Gets a collection of workflow actions for a user

Parameters:

user - the user

Returns:

the Collection of WorkflowActionModel