com.atlassian.jira.workflow
Interface WorkflowTransitionUtil

All Known Implementing Classes:

WorkflowTransitionUtilImpl

@PublicApi
public interface WorkflowTransitionUtil

Field Summary

static String	FIELD_COMMENT
static String	FIELD_COMMENT_GROUP_LEVEL
static String	FIELD_COMMENT_LEVEL
static String	FIELD_COMMENT_ROLE_LEVEL
static String	VIEW_COMMENTASSIGN
static Long	VIEW_COMMENTASSIGN_ID
static String	VIEW_RESOLVE
static Long	VIEW_RESOLVE_ID
static String	VIEW_SCREEN

Method Summary

void	addAdditionalInput(Object key, Object val) Pass a parameter into the action's "transientVars" parameter.
com.opensymphony.workflow.loader.ActionDescriptor	getActionDescriptor()
FieldScreenRenderer	getFieldScreenRenderer()
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 actionId)
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()

Field Detail

VIEW_RESOLVE

static final String VIEW_RESOLVE

See Also:

Constant Field Values

VIEW_COMMENTASSIGN

static final String VIEW_COMMENTASSIGN

See Also:

Constant Field Values

VIEW_SCREEN

static final String VIEW_SCREEN

See Also:

Constant Field Values

FIELD_COMMENT

static final String FIELD_COMMENT

See Also:

Constant Field Values

FIELD_COMMENT_LEVEL

static final String FIELD_COMMENT_LEVEL

See Also:

Constant Field Values

FIELD_COMMENT_ROLE_LEVEL

static final String FIELD_COMMENT_ROLE_LEVEL

See Also:

Constant Field Values

FIELD_COMMENT_GROUP_LEVEL

static final String FIELD_COMMENT_GROUP_LEVEL

See Also:

Constant Field Values

VIEW_COMMENTASSIGN_ID

static final Long VIEW_COMMENTASSIGN_ID

VIEW_RESOLVE_ID

static final Long VIEW_RESOLVE_ID

Method Detail

setIssue

void setIssue(MutableIssue issue)

setAction

void setAction(int actionId)

setParams

void setParams(Map params)

addAdditionalInput

void addAdditionalInput(Object key,
                        Object val)

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

Parameters:

key -

val -

validate

ErrorCollection validate()

progress

ErrorCollection progress()

getActionDescriptor

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

getUsername

String getUsername()

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

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

Returns:

username

setUsername

void setUsername(String username)

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

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

Parameters:

username - desired username

getUserKey

String getUserKey()

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

Returns:

username

setUserkey

void setUserkey(String userkey)

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

Parameters:

userkey - desired user's key

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer()

hasScreen

boolean hasScreen()

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

Returns:

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