com.atlassian.greenhopper.service.issue
Interface IssueFieldService

All Known Implementing Classes:

IssueFieldServiceImpl

public interface IssueFieldService

Holds persisted preferences specific functionality that deal with issue fields. Note: Preferably use IssueFieldManager for global field related functionality. This service deals with configuration specific stuff Note: this is currently a kitchen sink for various code snippets from preferences and context code.

Field Summary

static java.lang.String

SERVICE

Method Summary

IssueField	getDefaultSortField(com.opensymphony.user.User user, ProjectConfiguration projectConfiguration) Returns the default sort field for a project.
FlagField	getFlagField(com.opensymphony.user.User user, ProjectConfiguration projectConfiguration) Gets the flagged field for an XProject
java.util.TreeSet<IssueField>	getRankingFields(com.opensymphony.user.User user, ProjectConfiguration projectConfiguration) Get all ranking fields for a project.
IssueField	getSortField(com.opensymphony.user.User user, ProjectConfiguration projectConfiguration, java.lang.String fieldId) Get the sort field for a given fieldId.
java.util.Set<IssueField>	getSortFields(com.opensymphony.user.User user, ProjectConfiguration projectConfiguration) Returns all fields that are sortable - thus which can be used in jql to sort the results.
boolean	isRankable(com.opensymphony.user.User user, XProject xproject, IssueField sortField) Tells if the xproject can be ranked by the given sortField.

Field Detail

SERVICE

static final java.lang.String SERVICE

See Also:

Constant Field Values

Method Detail

getSortField

IssueField getSortField(com.opensymphony.user.User user,
                        ProjectConfiguration projectConfiguration,
                        java.lang.String fieldId)

Get the sort field for a given fieldId.

Returns:

the IssueField for fieldId, if and only if the field exists and is a sort field. the default sort field otherwise

getDefaultSortField

IssueField getDefaultSortField(com.opensymphony.user.User user,
                               ProjectConfiguration projectConfiguration)

Returns the default sort field for a project. This is either the first configured rank field, or the priority field in case rank fields are configured.

getSortFields

java.util.Set<IssueField> getSortFields(com.opensymphony.user.User user,
                                        ProjectConfiguration projectConfiguration)

Returns all fields that are sortable - thus which can be used in jql to sort the results.

getRankingFields

java.util.TreeSet<IssueField> getRankingFields(com.opensymphony.user.User user,
                                               ProjectConfiguration projectConfiguration)

Get all ranking fields for a project.

getFlagField

FlagField getFlagField(com.opensymphony.user.User user,
                       ProjectConfiguration projectConfiguration)

Gets the flagged field for an XProject

isRankable

boolean isRankable(com.opensymphony.user.User user,
                   XProject xproject,
                   IssueField sortField)

Tells if the xproject can be ranked by the given sortField.