@Internal public interface

JqlIssueSupport

com.atlassian.jira.jql.util.JqlIssueSupport
Known Indirect Subclasses

@Internal

This interface is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Some helper IssueLookup functions for JIRA.

Summary

Public Methods
Issue getIssue(String issueKey, ApplicationUser user)
Get the issue with the passed key if the passed user can see it.
Issue getIssue(String issueKey)
Get the issue with the passed key.
Issue getIssue(long id)
Get the issue given its id.
Issue getIssue(long id, ApplicationUser user)
Get the issue given its id if the passed user can see it.
@Deprecated Issue getIssue(long id, User user)
This method is deprecated. Use getIssue(long, com.atlassian.jira.user.ApplicationUser) instead. Since v6.1.
@Deprecated List<Issue> getIssues(String issueKey)
This method is deprecated. Use getIssue(String) instead. Since v6.1.
@Deprecated List<Issue> getIssues(String issueKey, User user)
This method is deprecated. Use getIssue(String, com.atlassian.jira.user.ApplicationUser) instead. Since v6.1.

Public Methods

public Issue getIssue (String issueKey, ApplicationUser user)

Get the issue with the passed key if the passed user can see it.

Parameters
issueKey they key of the issue to retrieve. A null key is assumed not to exist within JIRA.
user the user who must have permission to see the issue.
Returns
  • the issue identified by the passed key if it can be seen by the passed user. Null is returned if the issue key is not within JIRA or if the user does not have permission to see the issue.

public Issue getIssue (String issueKey)

Get the issue with the passed key.

Parameters
issueKey they key of the issue to retrieve. A null key is assumed not to exist within JIRA.
Returns
  • the issue identified by the passed key. Null is returned if the issue key is not within JIRA.

public Issue getIssue (long id)

Get the issue given its id. A null will be returned if the issue is not within JIRA.

Parameters
id the id of the issue to retrieve.
Returns
  • the issue identified by the passed id. A null value will be returned if the issue does not exist.

public Issue getIssue (long id, ApplicationUser user)

Get the issue given its id if the passed user can see it. A null will be returned if the issue key is not within JIRA or if the user does not have permission to see the issue.

Parameters
id the id of the issue to retreieve. A null key is assumed not to exist within JIRA.
user the user who must have permission to see the issue.
Returns
  • the issue identified by the passed id if it can be seen by the passed user. A null value will be returned if the issue does not exist or the user cannot see the issue.

@Deprecated public Issue getIssue (long id, User user)

This method is deprecated.
Use getIssue(long, com.atlassian.jira.user.ApplicationUser) instead. Since v6.1.

Get the issue given its id if the passed user can see it. A null will be returned if the issue key is not within JIRA or if the user does not have permission to see the issue.

Parameters
id the id of the issue to retreieve. A null key is assumed not to exist within JIRA.
user the user who must have permission to see the issue.
Returns
  • the issue identified by the passed id if it can be seen by the passed user. A null value will be returned if the issue does not exist or the user cannot see the issue.

@Deprecated public List<Issue> getIssues (String issueKey)

This method is deprecated.
Use getIssue(String) instead. Since v6.1.

Get the issues with the passed key. An empty list will be returned if the issue key is not within JIRA. Note: This no longer tries to do a case insensitive lookup.

Parameters
issueKey they key of the issue to retreieve. A null key is assumed not to exist within JIRA.
Returns
  • the issues identified by the passed key. An empty list will be returned if the issue key is not within JIRA.

@Deprecated public List<Issue> getIssues (String issueKey, User user)

This method is deprecated.
Use getIssue(String, com.atlassian.jira.user.ApplicationUser) instead. Since v6.1.

Get the issues with the passed key if the passed user can see it. An empty list will be returned if the issue key is not within JIRA or if the user does not have permission to see any of the issues. Note: This no longer tries to do a case insensitive lookup

Parameters
issueKey they key of the issue to retrieve. A null key is assumed not to exist within JIRA.
user the user who must have permission to see the issue.
Returns
  • the issues identified by the passed key if they can be seen by the passed user. An empty list will be returned if the issue key is not within JIRA or if the user does not have permission to see any of the issues.