com.atlassian.jira.issue.status.category

Interface StatusCategory

All Superinterfaces:

Comparable<StatusCategory>, Serializable

All Known Implementing Classes:

StatusCategoryImpl, WorkflowResource.DelegatedJsonStatusCategory

@PublicApi
public interface StatusCategory
extends Serializable, Comparable<StatusCategory>

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

Since:

v6.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETE
static String	IN_PROGRESS
static String	TO_DO
static String	UNDEFINED

Method Summary

Modifier and Type	Method and Description
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() Translated name for the status category.
String	getTranslatedName(I18nHelper i18n) Translated name for the status category.
String	getTranslatedName(String locale) Translated name for the status category.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

UNDEFINED

static final String UNDEFINED

See Also:

Constant Field Values

TO_DO

static final String TO_DO

See Also:

Constant Field Values

IN_PROGRESS

static final String IN_PROGRESS

See Also:

Constant Field Values

COMPLETE

static final String COMPLETE

See Also:

Constant Field Values

Method Detail

getId

Long getId()

getTranslatedName

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.

getTranslatedName

String getTranslatedName(String locale)

Translated name for the status category.

getTranslatedName

String getTranslatedName(I18nHelper i18n)

Translated name for the status category.

getKey

String getKey()

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

getName

String getName()

I18n independent human readable name for the status category.

Used primarily for locale-independent JQL statements.

Returns:

Human readable name

Since:

v6.2

getAliases

List<String> getAliases()

I18n independent human readable aliases for the status category.

Returns:

aliases for the category

Since:

v6.4

getPrimaryAlias

String getPrimaryAlias()

Returns:

first alias in the aliases or name if absent

Since:

v6.4

getColorName

String getColorName()

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

Returns:

getSequence

Long getSequence()