@PublicApi public interface

IssueWorkflowManager

com.atlassian.jira.workflow.IssueWorkflowManager
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).

Class Overview

Works with workflows on Issues.

While WorkflowManager deals with the global administration of Workflows, this Manager supplies operations that work on the wokrflow and current state of an individual Issue.

Summary

Public Methods
@Deprecated Collection<ActionDescriptor> getAvailableActions(Issue issue)
This method is deprecated. since v6.3
Collection<ActionDescriptor> getAvailableActions(Issue issue, ApplicationUser user)
Returns the Workflow actions that are valid for the given Issue in its current state for given user.
Collection<ActionDescriptor> getAvailableActions(Issue issue, TransitionOptions transitionOptions, ApplicationUser user)
Returns the Workflow actions that are valid for the given Issue in its current state for given user.
List<ActionDescriptor> getSortedAvailableActions(Issue issue, TransitionOptions transitionOptions, ApplicationUser user)
Returns the Workflow actions that are valid for the given Issue in its current state for given user.
List<ActionDescriptor> getSortedAvailableActions(Issue issue, ApplicationUser user)
Returns the Workflow actions that are valid for the given Issue in its current state for given user.
@Deprecated List<ActionDescriptor> getSortedAvailableActions(Issue issue)
This method is deprecated. since v6.3
boolean isValidAction(Issue issue, int actionId, ApplicationUser user)
Returns true if the given transition ID is valid for the given issue and given user.
boolean isValidAction(Issue issue, int actionId, TransitionOptions transitionOptions, ApplicationUser user)
Returns true if the given transition ID is valid for the given issue and current user.
@Deprecated boolean isValidAction(Issue issue, int action)
This method is deprecated. since v6.3

Public Methods

@Deprecated public Collection<ActionDescriptor> getAvailableActions (Issue issue)

This method is deprecated.
since v6.3

Returns the Workflow actions that are valid for the given Issue in its current state for current user.

This will call getAvailableActions below with defaults().

Parameters
issue the Issue
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

public Collection<ActionDescriptor> getAvailableActions (Issue issue, ApplicationUser user)

Returns the Workflow actions that are valid for the given Issue in its current state for given user.

This will call getAvailableActions below with defaults().

Parameters
issue the Issue
user user to check the permissions for
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

public Collection<ActionDescriptor> getAvailableActions (Issue issue, TransitionOptions transitionOptions, ApplicationUser user)

Returns the Workflow actions that are valid for the given Issue in its current state for given user.

Parameters
issue the Issue
transitionOptions options to skip conditions, permissions while performing action validation
user user to check the permissions for
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

public List<ActionDescriptor> getSortedAvailableActions (Issue issue, TransitionOptions transitionOptions, ApplicationUser user)

Returns the Workflow actions that are valid for the given Issue in its current state for given user. The list is sorted by the sequence number.

Parameters
issue the Issue
transitionOptions options to skip conditions, permissions while performing action validation
user user to check the permissions for
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

public List<ActionDescriptor> getSortedAvailableActions (Issue issue, ApplicationUser user)

Returns the Workflow actions that are valid for the given Issue in its current state for given user. The list is sorted by the sequence number.

This will call getSortedAvailableActions below with defaults().

Parameters
issue the Issue
user user to check the permissions for
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

@Deprecated public List<ActionDescriptor> getSortedAvailableActions (Issue issue)

This method is deprecated.
since v6.3

Returns the Workflow actions that are valid for the given Issue in its current state for current user. The list is sorted by the sequence number.

This will call getSortedAvailableActions below with defaults().

Parameters
issue the Issue
Returns
  • the Workflow actions that are valid for the given Issue in its current state.

public boolean isValidAction (Issue issue, int actionId, ApplicationUser user)

Returns true if the given transition ID is valid for the given issue and given user.

This will call isValidAction below with defaults().

Parameters
issue the Issue
actionId the id of the action we want to transition
user user to check the permissions for
Returns
  • true if it is ok to use the given transition on this issue.

public boolean isValidAction (Issue issue, int actionId, TransitionOptions transitionOptions, ApplicationUser user)

Returns true if the given transition ID is valid for the given issue and current user.

Parameters
issue the Issue
actionId the id of the action we want to transition
transitionOptions options to skip conditions, permissions while performing action validation
user user to check the permissions for
Returns
  • true if it is ok to use the given transition on this issue.

@Deprecated public boolean isValidAction (Issue issue, int action)

This method is deprecated.
since v6.3

Returns true if the given transition ID is valid for the given issue and current user.

This will call isValidAction below with defaults().

Parameters
issue the Issue
action the id of the action we want to transition
Returns
  • true if it is ok to use the given transition on this issue.