@PublicApi public interface

WorkflowTransitionUtil

com.atlassian.jira.workflow.WorkflowTransitionUtil
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

Constants
String FIELD_COMMENT
String FIELD_COMMENT_GROUP_LEVEL
String FIELD_COMMENT_LEVEL
String FIELD_COMMENT_ROLE_LEVEL
String VIEW_COMMENTASSIGN
String VIEW_RESOLVE
String VIEW_SCREEN
Fields
public static final Long VIEW_COMMENTASSIGN_ID
public static final Long VIEW_RESOLVE_ID
Public Methods
void addAdditionalInput(Object key, Object val)
Pass a parameter into the action's "transientVars" parameter.
ActionDescriptor getActionDescriptor()
FieldScreenRenderer getFieldScreenRenderer()
String getUserKey()
Gets key of user who the workflow transition will be executed as
String getUsername()
This method is 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)
This method is deprecated. Use setUserkey(String) instead. Since v6.0.
ErrorCollection validate()

Constants

public static final String FIELD_COMMENT

Constant Value: "comment"

public static final String FIELD_COMMENT_GROUP_LEVEL

Constant Value: "groupLevel"

public static final String FIELD_COMMENT_LEVEL

Constant Value: "commentLevel"

public static final String FIELD_COMMENT_ROLE_LEVEL

Constant Value: "roleLevel"

public static final String VIEW_COMMENTASSIGN

Constant Value: "commentassign"

public static final String VIEW_RESOLVE

Constant Value: "resolveissue"

public static final String VIEW_SCREEN

Constant Value: "fieldscreen"

Fields

public static final Long VIEW_COMMENTASSIGN_ID

public static final Long VIEW_RESOLVE_ID

Public Methods

public void addAdditionalInput (Object key, Object val)

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

public ActionDescriptor getActionDescriptor ()

public FieldScreenRenderer getFieldScreenRenderer ()

public String getUserKey ()

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

Returns
  • username

public String getUsername ()

This method is deprecated.
Use getUserKey() instead. Since v6.0.

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

Returns
  • username

public 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.

public ErrorCollection progress ()

public void setAction (int actionId)

public void setIssue (MutableIssue issue)

public void setParams (Map params)

public void setUserkey (String userkey)

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

Parameters
userkey desired user's key

public void setUsername (String username)

This method is deprecated.
Use setUserkey(String) instead. Since v6.0.

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

Parameters
username desired username

public ErrorCollection validate ()