Summary: Methods | [Expand All]
@PublicApi public interface

ConstantsService

com.atlassian.jira.bc.config.ConstantsService
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

This class contains methods for managing JIRA constants such as issue types, statuses, priorities and resolutions.

Summary

Public Methods
ServiceOutcome<Collection<IssueType>> getAllIssueTypes(User user)
Returns a ServiceOutcome containing all IssueTypes.
ServiceOutcome<Collection<StatusCategory>> getAllStatusCategories(User user)
Returns a ServiceOutcome containing all StatusCategories.
ServiceOutcome<Collection<Status>> getAllStatuses(User user)
Returns a ServiceOutcome containing all Statuses.
ServiceOutcome<StatusCategory> getDefaultStatusCategory(User user)
Returns a ServiceOutcome containing default StatusCategory.
ServiceOutcome<IssueType> getIssueTypeById(User user, String issueTypeId)
Returns a ServiceOutcome containing the IssueType that has the given id.
ServiceOutcome<Status> getStatusById(User user, String statusId)
Returns a ServiceOutcome containing the Status that has the given id.
ServiceOutcome<Status> getStatusByName(User user, String statusName)
Returns a ServiceOutcome containing the Status that has the given Name.
ServiceOutcome<Status> getStatusByTranslatedName(User user, String statusName)
Returns a ServiceOutcome containing the Status that has the given Name.
ServiceOutcome<StatusCategory> getStatusCategoryById(User user, String id)
Returns a ServiceOutcome containing StatusCategory that has the gived id.
ServiceOutcome<StatusCategory> getStatusCategoryByKey(User user, String key)
Returns a ServiceOutcome containing StatusCategory that has the gived key.
ServiceOutcome<Collection<StatusCategory>> getUserVisibleStatusCategories(User user)
Returns a ServiceOutcome containing StatusCategories visible to any user.
boolean isStatusAsLozengeEnabled()
Returns a boolean value indicating whether statuses should appear as lozenges or not.

Public Methods

public ServiceOutcome<Collection<IssueType>> getAllIssueTypes (User user)

Returns a ServiceOutcome containing all IssueTypes. Only issue types that the calling user has permission to see will be returned in the ServiceOutcome

Parameters
user the calling user
Returns
  • a ServiceOutcome

public ServiceOutcome<Collection<StatusCategory>> getAllStatusCategories (User user)

Returns a ServiceOutcome containing all StatusCategories.

Parameters
user the calling user. Will be used for formatting error messages
Returns
  • a ServiceOutcome

public ServiceOutcome<Collection<Status>> getAllStatuses (User user)

Returns a ServiceOutcome containing all Statuses. Only statuses that the calling user has permission to see will be returned in the ServiceOutcome

Parameters
user the calling user
Returns
  • a ServiceOutcome

public ServiceOutcome<StatusCategory> getDefaultStatusCategory (User user)

Returns a ServiceOutcome containing default StatusCategory. The method returns status category independently on dark feature state.

Parameters
user the calling User. Will be used for formatting error messages
Returns
  • a ServiceOutcome

public ServiceOutcome<IssueType> getIssueTypeById (User user, String issueTypeId)

Returns a ServiceOutcome containing the IssueType that has the given id. If there is no IssueType with the given id, or if the calling user does not have permission to see the IssueType, the ServiceOutcome will contain an error message to that effect. Otherwise, the IssueType can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user
issueTypeId a String containing an IssueType id
Returns
  • a ServiceOutcome

public ServiceOutcome<Status> getStatusById (User user, String statusId)

Returns a ServiceOutcome containing the Status that has the given id. If the Status with the provided id is not found, or if the calling user does not have permission to see the Status, the ServiceOutcome will contain the appropriate error. Otherwise, the status can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user
statusId a String containing a Status id
Returns
  • a ServiceOutcome

public ServiceOutcome<Status> getStatusByName (User user, String statusName)

Returns a ServiceOutcome containing the Status that has the given Name. If the Status with the provided Name is not found, or if the calling user does not have permission to see the Status, the ServiceOutcome will contain the appropriate error. Otherwise, the status can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user
statusName a String containing a Status name
Returns
  • a ServiceOutcome

public ServiceOutcome<Status> getStatusByTranslatedName (User user, String statusName)

Returns a ServiceOutcome containing the Status that has the given Name. The preference is to find the status by its translated name. If no matching translated name is found the true (untranslated) name will be tried. If the Status with the provided Name is not found, or if the calling user does not have permission to see the Status, the ServiceOutcome will contain the appropriate error. Otherwise, the status can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user
statusName a String containing a Status name
Returns
  • a ServiceOutcome

public ServiceOutcome<StatusCategory> getStatusCategoryById (User user, String id)

Returns a ServiceOutcome containing StatusCategory that has the gived id. If the Status with the provided id is not found, the ServiceOutcome will contain the appropriate error. Otherwise, the status can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user. Will be used for formatting error messages
id a String containing a StatusCategory id

public ServiceOutcome<StatusCategory> getStatusCategoryByKey (User user, String key)

Returns a ServiceOutcome containing StatusCategory that has the gived key. If the Status with the provided key is not found, the ServiceOutcome will contain the appropriate error. Otherwise, the status can be obtained by calling getReturnedValue() on the returned ServiceOutcome.

Parameters
user the calling user. Will be used for formatting error messages
key a String containing a StatusCategory id

public ServiceOutcome<Collection<StatusCategory>> getUserVisibleStatusCategories (User user)

Returns a ServiceOutcome containing StatusCategories visible to any user.

Parameters
user the calling user. Will be used for formatting error messages
Returns
  • a ServiceOutcome

public boolean isStatusAsLozengeEnabled ()

Returns a boolean value indicating whether statuses should appear as lozenges or not.

Returns
  • a boolean value