com.atlassian.jira.issue.label

Interface LabelUtil

All Known Implementing Classes:

DefaultLabelUtil

public interface LabelUtil

Utility to generate Label JQL strings.

Since:

v4.2

Method Summary

Modifier and Type	Method and Description
String	getLabelJql(ApplicationUser user, Long customFieldId, String label) Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPath(ApplicationUser, Long, String) instead.
String	getLabelJql(ApplicationUser user, String label) Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPath(ApplicationUser, String) instead.
String	getLabelJqlForProject(ApplicationUser user, Long projectId, Long customFieldId, String label) Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPathForProject(ApplicationUser, Long, Long, String) instead.
String	getLabelJqlForProject(ApplicationUser user, Long projectId, String label) Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPathForProject(ApplicationUser, Long, String) instead.
String	getLabelSearchPath(ApplicationUser user, Long customFieldId, String label) Given a label and custom field Id, this utility returns the URL to search for this label in the custom field provided
String	getLabelSearchPath(ApplicationUser user, String label) Given a label this utility returns the URL to search for this label in the system labels field
String	getLabelSearchPathForProject(ApplicationUser user, Long projectId, Long customFieldId, String label) Given a label, project id and custom field id, this utility returns the URL to search for this label in the label custom field, limited by the project provided
String	getLabelSearchPathForProject(ApplicationUser user, Long projectId, String label) Given a label and project id, this utility returns the URL to search for this label in the label system field, limited by the project provided

Method Detail

getLabelJql

String getLabelJql(ApplicationUser user,
                   String label)

Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPath(ApplicationUser, String) instead.

Given a label this utility returns a JQL string to search for this label in the system labels field

Parameters:

user - The user running the search

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

getLabelJql

String getLabelJql(ApplicationUser user,
                   Long customFieldId,
                   String label)

Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPath(ApplicationUser, Long, String) instead.

Given a label and custom field Id, this utility returns a JQL string to search for this label in the custom field provided

Parameters:

user - The user running the search

customFieldId - The CustomField Id of the labels custom field

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

getLabelJqlForProject

String getLabelJqlForProject(ApplicationUser user,
                             Long projectId,
                             String label)

Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPathForProject(ApplicationUser, Long, String) instead.

Given a label and project id, this utility returns a JQL string to search for this label in the label system field, limited by the project provided

Parameters:

user - The user running the search

projectId - The project to limit the search

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

getLabelJqlForProject

String getLabelJqlForProject(ApplicationUser user,
                             Long projectId,
                             Long customFieldId,
                             String label)

Deprecated. Since 7.1 beucase it generate old fashioned URLs. Use getLabelSearchPathForProject(ApplicationUser, Long, Long, String) instead.

Given a label, project id and custom field id, this utility returns a JQL string to search for this label in the label custom field, limited by the project provided

Parameters:

user - The user running the search

projectId - The project to limit the search

customFieldId - The CustomField Id of the labels custom field

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

getLabelSearchPath

String getLabelSearchPath(ApplicationUser user,
                          String label)

Given a label this utility returns the URL to search for this label in the system labels field

Parameters:

user - The user running the search

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

Since:

7.1

getLabelSearchPath

String getLabelSearchPath(ApplicationUser user,
                          Long customFieldId,
                          String label)

Given a label and custom field Id, this utility returns the URL to search for this label in the custom field provided

Parameters:

user - The user running the search

customFieldId - The CustomField Id of the labels custom field

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

Since:

7.1

getLabelSearchPathForProject

String getLabelSearchPathForProject(ApplicationUser user,
                                    Long projectId,
                                    String label)

Given a label and project id, this utility returns the URL to search for this label in the label system field, limited by the project provided

Parameters:

user - The user running the search

projectId - The project to limit the search

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

Since:

7.1

getLabelSearchPathForProject

String getLabelSearchPathForProject(ApplicationUser user,
                                    Long projectId,
                                    Long customFieldId,
                                    String label)

Given a label, project id and custom field id, this utility returns the URL to search for this label in the label custom field, limited by the project provided

Parameters:

user - The user running the search

projectId - The project to limit the search

customFieldId - The CustomField Id of the labels custom field

label - The label string to search for

Returns:

A jql string representing a valid query to search for this label

Since:

7.1