@PublicApi public class

TransitionOptions

extends Object
java.lang.Object
   ↳ com.atlassian.jira.workflow.TransitionOptions

@PublicApi

This class 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

This is a holder object for Transition options. Currently it is used to optionally skip conditions, validators and permissions while performing transitions

This could be expanded in future to cover further transition options.

Summary

Nested Classes
class TransitionOptions.Builder  
Public Methods
static TransitionOptions defaults()
Default options for transitioning.
Map<StringObject> getWorkflowParams()
boolean isAutomaticTransition()
boolean skipConditions()
boolean skipPermissions()
boolean skipValidators()
static TransitionOptions toTransitionOptions(Map<StringObject> workflowMap)
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static TransitionOptions defaults ()

Default options for transitioning. This will not skip conditions, validators or permissions. Business as usual.

Returns
  • default TransitionOptions

public Map<StringObject> getWorkflowParams ()

public boolean isAutomaticTransition ()

public boolean skipConditions ()

public boolean skipPermissions ()

public boolean skipValidators ()

public static TransitionOptions toTransitionOptions (Map<StringObject> workflowMap)