@PublicApi public interface

IssueConstant

implements Comparable<T>
com.atlassian.jira.issue.IssueConstant
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

Abstraction to represent any of the various constants like Resolution, Status etc.

Summary

Public Methods
@Deprecated void deleteTranslation(String issueConstantPrefix, Locale locale)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
String getCompleteIconUrl()
Returns the url for the icon with the context path added if necessary.
String getDescTranslation(String locale)
String getDescTranslation()
String getDescTranslation(I18nHelper i18n)
String getDescription()
GenericValue getGenericValue()
String getIconUrl()
String getIconUrlHtml()
Returns the HTML-escaped URL for this issue constant.
String getId()
String getName()
String getNameTranslation(String locale)
String getNameTranslation(I18nHelper i18n)
String getNameTranslation()
PropertySet getPropertySet()
Long getSequence()
@Deprecated void setDescription(String description)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
@Deprecated void setIconUrl(String iconURL)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
@Deprecated void setName(String name)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
@Deprecated void setSequence(Long sequence)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
@Deprecated void setTranslation(String translatedName, String translatedDesc, String issueConstantPrefix, Locale locale)
This method is deprecated. since v6.2. All updates should be performed via the relevant manager.
[Expand]
Inherited Methods
From interface java.lang.Comparable

Public Methods

@Deprecated public void deleteTranslation (String issueConstantPrefix, Locale locale)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.

public String getCompleteIconUrl ()

Returns the url for the icon with the context path added if necessary.

Returns
  • the url for the icon with the context path added if necessary. null will be returned if there is no icon URL.

public String getDescTranslation (String locale)

public String getDescTranslation ()

public String getDescTranslation (I18nHelper i18n)

public String getDescription ()

public GenericValue getGenericValue ()

public String getIconUrl ()

public String getIconUrlHtml ()

Returns the HTML-escaped URL for this issue constant.

Returns
  • a String containing an HTML-escaped icon URL
See Also

public String getId ()

public String getName ()

public String getNameTranslation (String locale)

public String getNameTranslation (I18nHelper i18n)

public String getNameTranslation ()

public PropertySet getPropertySet ()

public Long getSequence ()

@Deprecated public void setDescription (String description)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.

@Deprecated public void setIconUrl (String iconURL)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.

@Deprecated public void setName (String name)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.

@Deprecated public void setSequence (Long sequence)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.

@Deprecated public void setTranslation (String translatedName, String translatedDesc, String issueConstantPrefix, Locale locale)

This method is deprecated.
since v6.2. All updates should be performed via the relevant manager.