com.atlassian.jira.workflow

Class WorkflowTransitionUtilImpl

java.lang.Object

com.atlassian.jira.workflow.WorkflowTransitionUtilImpl

All Implemented Interfaces:

WorkflowProgressAware, WorkflowTransitionUtil

public class WorkflowTransitionUtilImpl
extends Object
implements WorkflowProgressAware, WorkflowTransitionUtil

Field Summary

Fields inherited from interface com.atlassian.jira.workflow.WorkflowTransitionUtil

FIELD_COMMENT, FIELD_COMMENT_GROUP_LEVEL, FIELD_COMMENT_LEVEL, FIELD_COMMENT_ROLE_LEVEL, VIEW_COMMENTASSIGN, VIEW_COMMENTASSIGN_ID, VIEW_RESOLVE, VIEW_RESOLVE_ID, VIEW_SCREEN

Constructor Summary

Constructors

Constructor and Description
WorkflowTransitionUtilImpl(JiraAuthenticationContext authenticationContext, WorkflowManager workflowManager, PermissionManager permissionManager, FieldScreenRendererFactory fieldScreenRendererFactory, CommentService commentService, I18nHelper.BeanFactory i18nFactory)

Method Summary

Modifier and Type	Method and Description
void	addAdditionalInput(Object key, Object value) Pass a parameter into the action's "transientVars" parameter.
void	addError(String name, String error)
void	addErrorMessage(String error)
int	getAction()
com.opensymphony.workflow.loader.ActionDescriptor	getActionDescriptor()
Map	getAdditionalInputs()
FieldScreenRenderer	getFieldScreenRenderer()
MutableIssue	getIssue()
Project	getProject()
Project	getProjectObject() Legacy synonym for WorkflowProgressAware.getProject()
ApplicationUser	getRemoteApplicationUser()
ApplicationUser	getRemoteUser() Deprecated. Use getRemoteApplicationUser() instead. Since v6.2.3.
String	getUserKey() Gets key of user who the workflow transition will be executed as
String	getUsername() Deprecated. Use getUserKey() instead. Since v6.0.
boolean	hasScreen() Checks if there's a screen associated with the workflow action for this transition.
ErrorCollection	progress()
void	setAction(int action)
void	setIssue(MutableIssue issue)
void	setParams(Map params)
void	setUserkey(String userkey) Sets key of user who the workflow transition will be executed as
void	setUsername(String username) Deprecated. Use setUserkey(String) instead. Since v6.0.
ErrorCollection	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowTransitionUtilImpl

public WorkflowTransitionUtilImpl(JiraAuthenticationContext authenticationContext,
                                  WorkflowManager workflowManager,
                                  PermissionManager permissionManager,
                                  FieldScreenRendererFactory fieldScreenRendererFactory,
                                  CommentService commentService,
                                  I18nHelper.BeanFactory i18nFactory)

Method Detail

getIssue

public MutableIssue getIssue()

Specified by:

getIssue in interface WorkflowProgressAware

setIssue

public void setIssue(MutableIssue issue)

Specified by:

setIssue in interface WorkflowTransitionUtil

getProject

public Project getProject()

Specified by:

getProject in interface WorkflowProgressAware

getProjectObject

public Project getProjectObject()

Description copied from interface: WorkflowProgressAware

Legacy synonym for WorkflowProgressAware.getProject()

Specified by:

getProjectObject in interface WorkflowProgressAware

Returns:

The project

getRemoteUser

public ApplicationUser getRemoteUser()

Deprecated. Use getRemoteApplicationUser() instead. Since v6.2.3.

Specified by:

getRemoteUser in interface WorkflowProgressAware

getRemoteApplicationUser

public ApplicationUser getRemoteApplicationUser()

Specified by:

getRemoteApplicationUser in interface WorkflowProgressAware

getAction

public int getAction()

Specified by:

getAction in interface WorkflowProgressAware

setAction

public void setAction(int action)

Specified by:

setAction in interface WorkflowProgressAware

Specified by:

setAction in interface WorkflowTransitionUtil

getActionDescriptor

public com.opensymphony.workflow.loader.ActionDescriptor getActionDescriptor()

Specified by:

getActionDescriptor in interface WorkflowTransitionUtil

addErrorMessage

public void addErrorMessage(String error)

Specified by:

addErrorMessage in interface WorkflowProgressAware

addError

public void addError(String name,
                     String error)

Specified by:

addError in interface WorkflowProgressAware

getAdditionalInputs

public Map getAdditionalInputs()

Specified by:

getAdditionalInputs in interface WorkflowProgressAware

addAdditionalInput

public void addAdditionalInput(Object key,
                               Object value)

Description copied from interface: WorkflowTransitionUtil

Pass a parameter into the action's "transientVars" parameter.

Specified by:

addAdditionalInput in interface WorkflowTransitionUtil

getUsername

public String getUsername()

Deprecated. Use getUserKey() instead. Since v6.0.

Description copied from interface: WorkflowTransitionUtil

Gets username of user who the workflow transition will be executed as

Specified by:

getUsername in interface WorkflowTransitionUtil

Returns:

username

setUsername

public void setUsername(String username)

Deprecated. Use setUserkey(String) instead. Since v6.0.

Description copied from interface: WorkflowTransitionUtil

Sets username of user who the workflow transition will be executed as

Specified by:

setUsername in interface WorkflowTransitionUtil

Parameters:

username - desired username

getUserKey

public String getUserKey()

Description copied from interface: WorkflowTransitionUtil

Gets key of user who the workflow transition will be executed as

Specified by:

getUserKey in interface WorkflowTransitionUtil

Returns:

username

setUserkey

public void setUserkey(String userkey)

Description copied from interface: WorkflowTransitionUtil

Sets key of user who the workflow transition will be executed as

Specified by:

setUserkey in interface WorkflowTransitionUtil

Parameters:

userkey - desired user's key

validate

public ErrorCollection validate()

Specified by:

validate in interface WorkflowTransitionUtil

getFieldScreenRenderer

public FieldScreenRenderer getFieldScreenRenderer()

Specified by:

getFieldScreenRenderer in interface WorkflowTransitionUtil

progress

public ErrorCollection progress()

Specified by:

progress in interface WorkflowTransitionUtil

setParams

public void setParams(Map params)

Specified by:

setParams in interface WorkflowTransitionUtil

hasScreen

public boolean hasScreen()

Description copied from interface: WorkflowTransitionUtil

Checks if there's a screen associated with the workflow action for this transition. Returns false if no screen is associated with the action.

Specified by:

hasScreen in interface WorkflowTransitionUtil

Returns:

true if a screen is associated with the current workflow action.