de.hybris.platform.cockpit.services.workflow

Interface WorkflowService

All Known Implementing Classes:

WorkflowServiceImpl

Deprecated.

since 6.3, please use WorkflowService instead. Add alias: <alias alias="workflowService" name="defaultWorkflowService"/> to your spring configuration to use new service. Use WorkflowConstants.WORKFLOW_SERVICE_BEAN_ID to refer to it where necessary.

@Deprecated
public interface WorkflowService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_CREATE Deprecated.
static java.lang.String	ACTION_REMOVE Deprecated.
static java.lang.String	ACTION_SAVE Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addComment(java.lang.Object comment, TypedObject action) Deprecated.
void	addItems(ItemModel workflowModel, java.util.List<TypedObject> itemsToAdd) Deprecated. adds given items to given workflow
void	assignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated.
boolean	canBeStarted(TypedObject workf) Deprecated.
ItemModel	containsItem(ItemModel modelData, java.util.List<TypedObject> itemsToAdd) Deprecated. Checks if given workflow has one of given items attached.
TypedObject	createAdhocWorkflow(java.lang.String defaultName, java.util.List<TypedObject> itemsToAdd) Deprecated. Creates adhoc workflow with given name, assigns given items to it and sets current user as owner.
TypedObject	createWorkflow(java.lang.String workflowName, WorkflowTemplateModel template, java.util.List<TypedObject> itemsToAdd) Deprecated.
Workflow	createWorkflow(WorkflowTemplate template, Item item) Deprecated.
void	decideAction(TypedObject action, TypedObject decision) Deprecated.
void	evaluteActivationScripts(TypedObject item, java.util.Map currentValues, java.util.Map initialValues, java.lang.String action) Deprecated.
java.util.Date	getActionCreationTime(TypedObject action) Deprecated.
java.lang.String	getActionName(TypedObject action) Deprecated.
PrincipalModel	getActionPrincipalAssigned(TypedObject action) Deprecated.
java.util.List<TypedObject>	getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType) Deprecated.
java.util.List<TypedObject>	getAllUserWorkflowActionsWithAttachment(java.lang.String attachmentClassName) Deprecated.
java.util.List<TypedObject>	getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachmentClassNames) Deprecated.
java.util.List<TypedObject>	getAllVisibleWorkflowTemplates() Deprecated.
java.util.List<TypedObject>	getAllWorkflows(int workflowsStatuses, int adhocWorkflowsStatuses, java.util.Date dateFrom, java.util.Date dateTo, java.util.Date adhocFilterFrom, java.util.Date adhocFilterTo) Deprecated.
java.util.List<TypedObject>	getAllWorkflowTemplates() Deprecated.
java.util.List<TypedObject>	getAttachmentsForAction(TypedObject action) Deprecated.
java.util.List<TypedObject>	getAttachmentsForAction(TypedObject action, java.util.List<java.lang.String> attachmentClassNames) Deprecated.
java.util.List<TypedObject>	getAttachmentsForAction(TypedObject action, java.lang.String attachmentClassName) Deprecated.
java.lang.String	getComment(TypedObject comment) Deprecated.
java.util.Date	getCommentCreationTime(TypedObject comment) Deprecated.
java.util.List<TypedObject>	getCommentsForAction(TypedObject action) Deprecated.
UserModel	getCommentUser(TypedObject comment) Deprecated.
java.lang.String	getDecisionCode(TypedObject decision) Deprecated.
java.lang.String	getDecisionName(TypedObject decision) Deprecated.
java.util.List<TypedObject>	getDecisionsForAction(TypedObject action) Deprecated.
java.util.List<WorkflowActionModel>	getEndWorkflowActions(WorkflowModel wfModel) Deprecated.
java.util.List<WorkflowActionModel>	getNormalWorkflowActions(WorkflowModel wfModel) Deprecated.
java.util.Date	getStartTime(WorkflowModel workflow) Deprecated.
java.util.List<TypedObject>	getStartWorkflowActions(TypedObject workflow) Deprecated.
java.util.List<WorkflowActionModel>	getStartWorkflowActions(WorkflowModel workflowModel) Deprecated.
java.lang.String	getStatusUrl(TypedObject typedData) Deprecated. since 6.3, use DefaultWorkflowHelper instead
java.util.List<WorkflowActionModel>	getWorkflowActionsByType(EnumerationValue type, WorkflowModel wfModel) Deprecated.
java.lang.String	getWorkflowName(TypedObject action) Deprecated.
java.util.List<TypedObject>	getWorkflowsByTemplate(TypedObject template) Deprecated.
boolean	isAdhocWorkflow(TypedObject workflow) Deprecated.
boolean	isAutomatedComment(TypedObject comment) Deprecated.
boolean	isFinished(java.lang.Object workflowModel) Deprecated.
boolean	isPaused(java.lang.Object workflowModel) Deprecated.
boolean	isPlanned(java.lang.Object workflowModel) Deprecated.
boolean	isRunning(java.lang.Object workflowModel) Deprecated.
boolean	isTerminated(java.lang.Object workflowModel) Deprecated.
void	startWorkflow(ItemModel workflowModel) Deprecated. starts given (adhoc) workflow
void	terminateWorkflow(ItemModel workflowModel) Deprecated. terminate given (adhoc) workflow
void	unassignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated.

Field Detail

ACTION_CREATE

static final java.lang.String ACTION_CREATE

Deprecated.

See Also:

Constant Field Values

ACTION_REMOVE

static final java.lang.String ACTION_REMOVE

Deprecated.

See Also:

Constant Field Values

ACTION_SAVE

static final java.lang.String ACTION_SAVE

Deprecated.

See Also:

Constant Field Values

Method Detail

getStartWorkflowActions

@Deprecated
java.util.List<TypedObject> getStartWorkflowActions(TypedObject workflow)

Deprecated.

Gets all workflow actions that are marked as 'start action', use getStartWorkflowActions(WorkflowModel) instead.

Parameters:

workflow - workflow

getAllUserWorkflowActionsWithAttachment

java.util.List<TypedObject> getAllUserWorkflowActionsWithAttachment(java.lang.String attachmentClassName)

Deprecated.

getAllUserWorkflowActionsWithAttachment

java.util.List<TypedObject> getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType)

Deprecated.

getAllUserWorkflowActionsWithAttachments

java.util.List<TypedObject> getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachmentClassNames)

Deprecated.

getCommentsForAction

java.util.List<TypedObject> getCommentsForAction(TypedObject action)

Deprecated.

getAttachmentsForAction

java.util.List<TypedObject> getAttachmentsForAction(TypedObject action)

Deprecated.

getAttachmentsForAction

java.util.List<TypedObject> getAttachmentsForAction(TypedObject action,
                                                    java.lang.String attachmentClassName)

Deprecated.

getAttachmentsForAction

java.util.List<TypedObject> getAttachmentsForAction(TypedObject action,
                                                    java.util.List<java.lang.String> attachmentClassNames)

Deprecated.

getDecisionsForAction

java.util.List<TypedObject> getDecisionsForAction(TypedObject action)

Deprecated.

getWorkflowName

java.lang.String getWorkflowName(TypedObject action)

Deprecated.

getActionName

java.lang.String getActionName(TypedObject action)

Deprecated.

getActionCreationTime

java.util.Date getActionCreationTime(TypedObject action)

Deprecated.

getActionPrincipalAssigned

PrincipalModel getActionPrincipalAssigned(TypedObject action)

Deprecated.

decideAction

void decideAction(TypedObject action,
                  TypedObject decision)

Deprecated.

getDecisionName

java.lang.String getDecisionName(TypedObject decision)

Deprecated.

getDecisionCode

java.lang.String getDecisionCode(TypedObject decision)

Deprecated.

getComment

java.lang.String getComment(TypedObject comment)

Deprecated.

getCommentUser

UserModel getCommentUser(TypedObject comment)

Deprecated.

getCommentCreationTime

java.util.Date getCommentCreationTime(TypedObject comment)

Deprecated.

addComment

void addComment(java.lang.Object comment,
                TypedObject action)

Deprecated.

evaluteActivationScripts

void evaluteActivationScripts(TypedObject item,
                              java.util.Map currentValues,
                              java.util.Map initialValues,
                              java.lang.String action)

Deprecated.

Parameters:

item -

currentValues -

initialValues -

action -

createWorkflow

Workflow createWorkflow(WorkflowTemplate template,
                        Item item)

Deprecated.

createWorkflow

TypedObject createWorkflow(java.lang.String workflowName,
                           WorkflowTemplateModel template,
                           java.util.List<TypedObject> itemsToAdd)

Deprecated.

isAutomatedComment

boolean isAutomatedComment(TypedObject comment)

Deprecated.

getAllWorkflowTemplates

java.util.List<TypedObject> getAllWorkflowTemplates()

Deprecated.

getWorkflowsByTemplate

java.util.List<TypedObject> getWorkflowsByTemplate(TypedObject template)

Deprecated.

getAllWorkflows

java.util.List<TypedObject> getAllWorkflows(int workflowsStatuses,
                                            int adhocWorkflowsStatuses,
                                            java.util.Date dateFrom,
                                            java.util.Date dateTo,
                                            java.util.Date adhocFilterFrom,
                                            java.util.Date adhocFilterTo)

Deprecated.

Parameters:

workflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for other values

adhocWorkflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for other values

Returns:

List of workflows fulfilling given criteria, e.g. if only planned and running workflows should be returned then put 3 as workflowsStatuses and 0 for adhocWorkflowsStatuses.

createAdhocWorkflow

TypedObject createAdhocWorkflow(java.lang.String defaultName,
                                java.util.List<TypedObject> itemsToAdd)

Deprecated.

Creates adhoc workflow with given name, assigns given items to it and sets current user as owner.

Parameters:

itemsToAdd - list of items to add

defaultName - of adhoc workflow

Returns:

created adhoc workflow

assignUser

void assignUser(PrincipalModel principalModel,
                WorkflowModel workflow)

Deprecated.

Parameters:

principalModel - to assign to given workflow

getAllVisibleWorkflowTemplates

java.util.List<TypedObject> getAllVisibleWorkflowTemplates()

Deprecated.

Returns:

all visible workflow templates for current session user, including templates that user is owner of, excluding special adhoc-workflow template

isPaused

boolean isPaused(java.lang.Object workflowModel)

Deprecated.

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is paused

startWorkflow

void startWorkflow(ItemModel workflowModel)

Deprecated.

starts given (adhoc) workflow

terminateWorkflow

void terminateWorkflow(ItemModel workflowModel)

Deprecated.

terminate given (adhoc) workflow

isTerminated

boolean isTerminated(java.lang.Object workflowModel)

Deprecated.

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is terminated

isRunning

boolean isRunning(java.lang.Object workflowModel)

Deprecated.

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is running

isFinished

boolean isFinished(java.lang.Object workflowModel)

Deprecated.

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is finished

isPlanned

boolean isPlanned(java.lang.Object workflowModel)

Deprecated.

Parameters:

workflowModel - or adhoc workflow model

Returns:

true if workflow is planned

addItems

void addItems(ItemModel workflowModel,
              java.util.List<TypedObject> itemsToAdd)

Deprecated.

adds given items to given workflow

containsItem

ItemModel containsItem(ItemModel modelData,
                       java.util.List<TypedObject> itemsToAdd)

Deprecated.

Checks if given workflow has one of given items attached.

Returns:

first item from given list found in workflow, null otherwise

isAdhocWorkflow

boolean isAdhocWorkflow(TypedObject workflow)

Deprecated.

Returns:

true if given workflow was created out of adhoc-workflow template

canBeStarted

boolean canBeStarted(TypedObject workf)

Deprecated.

Returns:

true if given workflow can be started, false otherwise (e.g. when there are is no user assigned)

getStatusUrl

@Deprecated
java.lang.String getStatusUrl(TypedObject typedData)

Deprecated. since 6.3, use DefaultWorkflowHelper instead

Returns:

url to picture representing current status of given workflow

getStartTime

java.util.Date getStartTime(WorkflowModel workflow)

Deprecated.

Returns:

start time of given workflow

unassignUser

void unassignUser(PrincipalModel principalModel,
                  WorkflowModel workflow)

Deprecated.

Parameters:

principalModel - to unassign from given adhoc workflow

getStartWorkflowActions

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

Deprecated.

Returns:

all workflow actions that are marked as 'start action'

getNormalWorkflowActions

java.util.List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel wfModel)

Deprecated.

Returns:

all workflow actions that are marked as 'normal action'

getEndWorkflowActions

java.util.List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel wfModel)

Deprecated.

Returns:

all workflow actions that are marked as 'end action'

getWorkflowActionsByType

java.util.List<WorkflowActionModel> getWorkflowActionsByType(EnumerationValue type,
                                                             WorkflowModel wfModel)

Deprecated.

Returns:

all workflow actions which are of given type