com.atlassian.jira.workflow

Interface IssueWorkflowManager

All Known Implementing Classes:

IssueWorkflowManagerImpl

@PublicApi
public interface IssueWorkflowManager

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.

Since:

v5.0

See Also:

IssueManager, WorkflowManager

Method Summary

Modifier and Type	Method and Description
Collection<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActions(Issue issue) Deprecated. since v6.3
Collection<com.opensymphony.workflow.loader.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<com.opensymphony.workflow.loader.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<com.opensymphony.workflow.loader.ActionDescriptor>	getSortedAvailableActions(Issue issue) Deprecated. since v6.3
List<com.opensymphony.workflow.loader.ActionDescriptor>	getSortedAvailableActions(Issue issue, ApplicationUser user) Returns the Workflow actions that are valid for the given Issue in its current state for given user.
List<com.opensymphony.workflow.loader.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.
boolean	isValidAction(Issue issue, int action) 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.

Method Detail

getAvailableActions

@Deprecated
Collection<com.opensymphony.workflow.loader.ActionDescriptor> getAvailableActions(Issue issue)

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 TransitionOptions.defaults().

Parameters:

issue - the Issue

Returns:

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

getAvailableActions

Collection<com.opensymphony.workflow.loader.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 TransitionOptions.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.

Since:

v6.3

getAvailableActions

Collection<com.opensymphony.workflow.loader.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.

Since:

v6.3

getSortedAvailableActions

@Deprecated
List<com.opensymphony.workflow.loader.ActionDescriptor> getSortedAvailableActions(Issue issue)

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 TransitionOptions.defaults().

Parameters:

issue - the Issue

Returns:

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

getSortedAvailableActions

List<com.opensymphony.workflow.loader.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 TransitionOptions.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.

Since:

v6.3

getSortedAvailableActions

List<com.opensymphony.workflow.loader.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.

Since:

v6.3

isValidAction

@Deprecated
boolean isValidAction(Issue issue,
                                  int action)

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

isValidAction

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

Since:

v6.3

isValidAction

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.

Since:

v6.3