com.atlassian.jira.jql.util
Class JqlIssueSupportImpl

java.lang.Object
  extended by com.atlassian.jira.jql.util.JqlIssueSupportImpl
All Implemented Interfaces:
JqlIssueSupport

public class JqlIssueSupportImpl
extends Object
implements JqlIssueSupport

Default implementation of JqlIssueSupport.

Since:
v4.0

Constructor Summary
JqlIssueSupportImpl(IssueManager issueManager, PermissionManager permissionManager)
           
 
Method Summary
 Set<Long> getIdsOfMissingIssues(Set<Long> issueIds)
          Check existence of issues for the given set of IDs
 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.
 Issue getIssue(long id, com.atlassian.crowd.embedded.api.User user)
          Get the issue given its id if the passed user can see it.
 Issue getIssue(String issueKey)
          Get the issue with the passed key.
 Issue getIssue(String issueKey, ApplicationUser user)
          Get the issue with the passed key if the passed user can see it.
 List<Issue> getIssues(String issueKey)
          Get the issues with the passed key.
 List<Issue> getIssues(String issueKey, com.atlassian.crowd.embedded.api.User user)
          Get the issues with the passed key if the passed user can see it.
 Set<String> getKeysOfMissingIssues(Set<String> issueKeys)
          Check existence of issues for the given set of keys
 Set<Pair<Long,String>> getProjectIssueTypePairsByIds(Set<Long> issueIds)
          Returns a set of project ID / issue type combinations that given issue IDs cover.
 Set<Pair<Long,String>> getProjectIssueTypePairsByKeys(Set<String> issueKeys)
          Returns a set of project ID / issue type combinations that given issue keys cover.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JqlIssueSupportImpl

public JqlIssueSupportImpl(IssueManager issueManager,
                           PermissionManager permissionManager)
Method Detail

getIssue

public Issue getIssue(long id,
                      com.atlassian.crowd.embedded.api.User user)
Description copied from interface: JqlIssueSupport
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.

Specified by:
getIssue in interface JqlIssueSupport
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

public Issue getIssue(long id,
                      ApplicationUser user)
Description copied from interface: JqlIssueSupport
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.

Specified by:
getIssue in interface JqlIssueSupport
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

public Issue getIssue(long id)
Description copied from interface: JqlIssueSupport
Get the issue given its id. A null will be returned if the issue is not within JIRA.

Specified by:
getIssue in interface JqlIssueSupport
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

public List<Issue> getIssues(String issueKey,
                             com.atlassian.crowd.embedded.api.User user)
Description copied from interface: JqlIssueSupport
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

Specified by:
getIssues in interface JqlIssueSupport
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.
See Also:
for a version with no permission check

getIssues

public List<Issue> getIssues(String issueKey)
Description copied from interface: JqlIssueSupport
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.

Specified by:
getIssues in interface JqlIssueSupport
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

getIssue

public Issue getIssue(String issueKey,
                      ApplicationUser user)
Description copied from interface: JqlIssueSupport
Get the issue with the passed key if the passed user can see it.

Specified by:
getIssue in interface JqlIssueSupport
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.
See Also:
for a version with no permission check

getIssue

public Issue getIssue(String issueKey)
Description copied from interface: JqlIssueSupport
Get the issue with the passed key.

Specified by:
getIssue in interface JqlIssueSupport
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.
See Also:
for a version with permission checks

getProjectIssueTypePairsByKeys

@Nonnull
public Set<Pair<Long,String>> getProjectIssueTypePairsByKeys(@Nonnull
                                                                     Set<String> issueKeys)
Description copied from interface: JqlIssueSupport
Returns a set of project ID / issue type combinations that given issue keys cover.

Specified by:
getProjectIssueTypePairsByKeys in interface JqlIssueSupport
Parameters:
issueKeys - Set of issue keys
Returns:
Project ID / issue type pairs

getProjectIssueTypePairsByIds

@Nonnull
public Set<Pair<Long,String>> getProjectIssueTypePairsByIds(@Nonnull
                                                                    Set<Long> issueIds)
Description copied from interface: JqlIssueSupport
Returns a set of project ID / issue type combinations that given issue IDs cover.

Specified by:
getProjectIssueTypePairsByIds in interface JqlIssueSupport
Parameters:
issueIds - Set of issue IDs
Returns:
Project ID / issue type pairs

getKeysOfMissingIssues

@Nonnull
public Set<String> getKeysOfMissingIssues(@Nonnull
                                                  Set<String> issueKeys)
Description copied from interface: JqlIssueSupport
Check existence of issues for the given set of keys

Specified by:
getKeysOfMissingIssues in interface JqlIssueSupport
Parameters:
issueKeys - Set of issue keys
Returns:
Set of invalid keys or the ones that don't represent an issue

getIdsOfMissingIssues

@Nonnull
public Set<Long> getIdsOfMissingIssues(@Nonnull
                                               Set<Long> issueIds)
Description copied from interface: JqlIssueSupport
Check existence of issues for the given set of IDs

Specified by:
getIdsOfMissingIssues in interface JqlIssueSupport
Parameters:
issueIds - Set of issue IDs
Returns:
Set of IDs that don't represent an issue


Copyright © 2002-2014 Atlassian. All Rights Reserved.