@PublicApi public interface

StatusCategory

implements Serializable Comparable<T>
com.atlassian.jira.issue.status.category.StatusCategory
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

Represents single group of Status which has similar positions in terms of representing in workflows.

Summary

Constants
String COMPLETE
String IN_PROGRESS
String TO_DO
String UNDEFINED
Public Methods
List<String> getAliases()
I18n independent human readable aliases for the status category.
String getColorName()
Returns one of the 6 defined ADG colors: "medium-gray", "green", "yellow", "brown", "warm-red", "blue-gray"
Long getId()
String getKey()
Unique String identifier of given category.
String getName()
I18n independent human readable name for the status category.
String getPrimaryAlias()
Long getSequence()
String getTranslatedName(I18nHelper i18n)
Translated name for the status category.
String getTranslatedName(String locale)
Translated name for the status category.
String getTranslatedName()
Translated name for the status category.
[Expand]
Inherited Methods
From interface java.lang.Comparable

Constants

public static final String COMPLETE

Constant Value: "done"

public static final String IN_PROGRESS

Constant Value: "indeterminate"

public static final String TO_DO

Constant Value: "new"

public static final String UNDEFINED

Constant Value: "undefined"

Public Methods

public List<String> getAliases ()

I18n independent human readable aliases for the status category.

Returns
  • aliases for the category

public String getColorName ()

Returns one of the 6 defined ADG colors: "medium-gray", "green", "yellow", "brown", "warm-red", "blue-gray"

public Long getId ()

public String getKey ()

Unique String identifier of given category. Should not contain any spaces and non-standard ASCII characters.

public String getName ()

I18n independent human readable name for the status category.

Used primarily for locale-independent JQL statements.

Returns
  • Human readable name

public String getPrimaryAlias ()

Returns
  • first alias in the aliases or name if absent

public Long getSequence ()

public String getTranslatedName (I18nHelper i18n)

Translated name for the status category.

public String getTranslatedName (String locale)

Translated name for the status category.

public String getTranslatedName ()

Translated name for the status category. Don't call this in a background thread! It'll fall back to the server's locale. Use getTranslatedName(com.atlassian.jira.util.I18nHelper) instead.