Package com.atlassian.jira.jql.util
Interface JqlIssueSupport
- All Known Implementing Classes:
JqlIssueSupportImpl
@Internal
public interface JqlIssueSupport
Some helper IssueLookup functions for JIRA.
- Since:
- v4.0
-
Method Summary
Modifier and TypeMethodDescriptiongetIdsOfMissingIssues(Set<Long> issueIds) Check existence of issues for the given set of IDsgetIssue(long id) Get the issue given its id.getIssue(long id, ApplicationUser user) Get the issue given its id if the passed user can see it.Get the issue with the passed key.getIssue(String issueKey, ApplicationUser user) Get the issue with the passed key if the passed user can see it.getKeysOfMissingIssues(Set<String> issueKeys) Check existence of issues for the given set of keysgetProjectIssueTypePairsByIds(Set<Long> issueIds) Returns a set of project ID / issue type combinations that given issue IDs cover.getProjectIssueTypePairsByKeys(Set<String> issueKeys) Returns a set of project ID / issue type combinations that given issue keys cover.
-
Method Details
-
getIssue
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
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.
-
getIssue
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.
- See Also:
-
getIssue
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.
- See Also:
-
getProjectIssueTypePairsByKeys
@Internal @Nonnull Set<Pair<Long,String>> getProjectIssueTypePairsByKeys(@Nonnull Set<String> issueKeys) Returns a set of project ID / issue type combinations that given issue keys cover.- Parameters:
issueKeys- Set of issue keys- Returns:
- Project ID / issue type pairs
-
getProjectIssueTypePairsByIds
@Internal @Nonnull Set<Pair<Long,String>> getProjectIssueTypePairsByIds(@Nonnull Set<Long> issueIds) Returns a set of project ID / issue type combinations that given issue IDs cover.- Parameters:
issueIds- Set of issue IDs- Returns:
- Project ID / issue type pairs
-
getKeysOfMissingIssues
Check existence of issues for the given set of keys- Parameters:
issueKeys- Set of issue keys- Returns:
- Set of invalid keys or the ones that don't represent an issue
-
getIdsOfMissingIssues
Check existence of issues for the given set of IDs- Parameters:
issueIds- Set of issue IDs- Returns:
- Set of IDs that don't represent an issue
-