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

Collection<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActions(Issue issue) Returns the Workflow actions that are valid for the given Issue in its current state.
Collection<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActions(Issue issue, TransitionOptions transitionOptions) Returns the Workflow actions that are valid for the given Issue in its current state.
List<com.opensymphony.workflow.loader.ActionDescriptor>	getSortedAvailableActions(Issue issue) Returns the Workflow actions that are valid for the given Issue in its current state.
List<com.opensymphony.workflow.loader.ActionDescriptor>	getSortedAvailableActions(Issue issue, TransitionOptions transitionOptions) Returns the Workflow actions that are valid for the given Issue in its current state.
boolean	isValidAction(Issue issue, int action) Returns true if the given transition ID is valid for the given issue.
boolean	isValidAction(Issue issue, int action, TransitionOptions transitionOptions) Returns true if the given transition ID is valid for the given issue.

Method Detail

getAvailableActions

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

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

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,
                                                                                  TransitionOptions transitionOptions)

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

Parameters:

issue - the Issue

transitionOptions - options to skip conditions, permissions while performing action validation

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)

Returns the Workflow actions that are valid for the given Issue in its current state. 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,
                                                                                  TransitionOptions transitionOptions)

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

Parameters:

issue - the Issue

transitionOptions - options to skip conditions, permissions while performing action validation

Returns:

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

Since:

v6.3

isValidAction

boolean isValidAction(Issue issue,
                      int action)

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

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 action,
                      TransitionOptions transitionOptions)

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

Parameters:

issue - the Issue

action - the id of the action we want to transition

transitionOptions - options to skip conditions, permissions while performing action validation

Returns:

true if it is ok to use the given transition on this issue.

Since:

v6.3