Package com.atlassian.jira.bc.issue.link
Interface IssueLinkService
- All Known Implementing Classes:
DefaultIssueLinkService
@PublicApi
public interface IssueLinkService
Provides methods to link two JIRA Issues.
- Since:
- v5.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
static class
static class
static class
static class
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the issue link to the issue specified by the validation result.void
delete
(IssueLinkService.DeleteIssueLinkValidationResult deleteValidationResult) Deletes the issue link with the given id from the JIRA datastore, if the current user has permission to do so.getIssueLink
(Long issueLinkId, ApplicationUser user) Returns the issue link for the given id.getIssueLink
(Long sourceId, Long destinationId, Long issueLinkTypeId) Returns the issue link or null if not found.getIssueLinks
(ApplicationUser user, Issue issue) Returns the issue links that the specified user can see.getIssueLinks
(ApplicationUser user, Issue issue, boolean excludeSystemLinks) validateAddIssueLinks
(ApplicationUser user, Issue issue, Long issueLinkTypeId, Direction direction, Collection<String> linkKeys, boolean excludeSystemLinks) validateAddIssueLinks
(ApplicationUser user, Issue issue, String linkName, Collection<String> linkKeys) Validates that the user provided can add the link provided for a particular issue.validateDelete
(ApplicationUser user, Issue issue, IssueLink issueLink) Validates parameters and checks permissions, and if all checks pass it will create aIssueLinkService.DeleteIssueLinkValidationResult
that can be passed to thedelete(DeleteIssueLinkValidationResult)
method.
-
Method Details
-
getIssueLinkTypes
Collection<IssueLinkType> getIssueLinkTypes()- Returns:
- the all issue link types defined in JIRA
-
getIssueLink
Returns the issue link or null if not found.- Parameters:
sourceId
- source issue id of the linkdestinationId
- destination issue id of the linkissueLinkTypeId
- link type id of the link- Returns:
- issue link or null if not found
-
getIssueLink
Returns the issue link for the given id. It will return the issue link if the user has the permission to see the source and destination issue of this issue link.- Parameters:
issueLinkId
- issue link id.user
- The user performing the operation- Returns:
- a result that contains the issue link.
-
getIssueLinks
Returns the issue links that the specified user can see. Will only return non-system (user-defined) links.- Parameters:
user
- The user performing the operationissue
- The issue that links will retrieved on- Returns:
- a result that contains the issue links
-
getIssueLinks
IssueLinkService.IssueLinkResult getIssueLinks(ApplicationUser user, Issue issue, boolean excludeSystemLinks) - Parameters:
user
- The user performing the operationissue
- The issue that links will retrieved onexcludeSystemLinks
- whether or not to exclude system links- Returns:
- a result that contains the issue links
- See Also:
-
#getIssueLinks(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue)
-
validateAddIssueLinks
IssueLinkService.AddIssueLinkValidationResult validateAddIssueLinks(ApplicationUser user, Issue issue, String linkName, Collection<String> linkKeys) Validates that the user provided can add the link provided for a particular issue. Validation will ensure that the user has the EDIT_ISSUE permission for the issue in question. The label will also be validated to ensure that it doesn't contain spaces and that it doesn't exceed the max length of 255 characters.Only user-created (i.e. non-system) links are allowed.
- Parameters:
user
- The user performing the operationissue
- The issue that links will be set onlinkName
- The actual link name as strings to set on the issuelinkKeys
- The collection of issue keys to link against- Returns:
- a validation result, that can be used to set the labels or to display errors.
-
validateAddIssueLinks
IssueLinkService.AddIssueLinkValidationResult validateAddIssueLinks(ApplicationUser user, Issue issue, Long issueLinkTypeId, Direction direction, Collection<String> linkKeys, boolean excludeSystemLinks) - Parameters:
user
- The user performing the operationissue
- The issue that links will be set onissueLinkTypeId
- The actual link id to set on the issuedirection
- which direction we are linking inlinkKeys
- The collection of issue keys to link againstexcludeSystemLinks
- whether or not system links are okay- Returns:
- a validation result, that can be used to set the labels or to display errors.
-
addIssueLinks
Adds the issue link to the issue specified by the validation result.- Parameters:
user
- The user performing the operationresult
- The validation result obtained via#validateAddIssueLinks(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, String, java.util.Collection)
-
validateDelete
IssueLinkService.DeleteIssueLinkValidationResult validateDelete(ApplicationUser user, Issue issue, IssueLink issueLink) Validates parameters and checks permissions, and if all checks pass it will create aIssueLinkService.DeleteIssueLinkValidationResult
that can be passed to thedelete(DeleteIssueLinkValidationResult)
method.- Parameters:
user
- who the permission checks will be run against (can be null, indicating an anonymous user)issue
- issue the link is being deleted fromissueLink
- issue link to be deleted- Returns:
- a validation result, if all validation and permission passes it will contain a validated issue link id, otherwise the issue link id will be null
-
delete
Deletes the issue link with the given id from the JIRA datastore, if the current user has permission to do so.- Parameters:
deleteValidationResult
- contains the remote issue link id to delete. This should have been created by the#validateDelete(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.link.IssueLink)
method. The result must haveServiceResult.isValid()
return true. If false this method will throw an IllegalStateException.
-