com.atlassian.jira.jql.util
Interface JqlIssueSupport

All Known Implementing Classes:
JqlIssueSupportImpl

public interface JqlIssueSupport

Some helper IssueLookup functions for JIRA.

Since:
v4.0

Method Summary
 Issue getIssue(long id)
          Get the issue given its id.
 Issue getIssue(long id, User user)
          Get the issue given its id if the passed user can see it.
 List<Issue> getIssues(String issueKey)
          Get the issues with the passed key.
 List<Issue> getIssues(String issueKey, User user)
          Get the issues with the passed key if the passed user can see it.
 

Method Detail

getIssue

Issue getIssue(long id,
               User 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.

getIssue

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.

getIssues

List<Issue> getIssues(String issueKey,
                      User user)
Get the issues with the passed key if the passed user can see it. This tries to do a case insensitive lookup which is why it can return multiple values. 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.

Parameters:
issueKey - they key 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 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.
See Also:
for a version with no permission check

getIssues

List<Issue> getIssues(String issueKey)
Get the issues with the passed key. This tries to do a case insensitive lookup which is why it can return multiple values. An empty list will be returned if the issue key is not within JIRA.

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.
See Also:
for a version with permission checks


Copyright © 2002-2009 Atlassian. All Rights Reserved.