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:

RemoteIssueLinkService

Nested Class Summary

static class	IssueLinkService.AddIssueLinkValidationResult
static class	IssueLinkService.DeleteIssueLinkValidationResult
static class	IssueLinkService.IssueLinkResult
static class	IssueLinkService.IssueLinkValidationResult
static class	IssueLinkService.SingleIssueLinkResult

Method Summary

void	addIssueLinks(com.atlassian.crowd.embedded.api.User user, IssueLinkService.AddIssueLinkValidationResult result) 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.
IssueLink	getIssueLink(Long sourceId, Long destinationId, Long issueLinkTypeId) Returns the issue link or null if not found.
IssueLinkService.SingleIssueLinkResult	getIssueLink(Long issueLinkId, com.atlassian.crowd.embedded.api.User user) Returns the issue link for the given id.
IssueLinkService.IssueLinkResult	getIssueLinks(com.atlassian.crowd.embedded.api.User user, Issue issue) Returns the issue links that the specified user can see.
IssueLinkService.IssueLinkResult	getIssueLinks(com.atlassian.crowd.embedded.api.User user, Issue issue, boolean excludeSystemLinks)
Collection<IssueLinkType>	getIssueLinkTypes()
IssueLinkService.AddIssueLinkValidationResult	validateAddIssueLinks(com.atlassian.crowd.embedded.api.User user, Issue issue, Long issueLinkTypeId, Direction direction, Collection<String> linkKeys, boolean excludeSystemLinks)
IssueLinkService.AddIssueLinkValidationResult	validateAddIssueLinks(com.atlassian.crowd.embedded.api.User user, Issue issue, String linkName, Collection<String> linkKeys) Validates that the user provided can add the link provided for a particular issue.
IssueLinkService.DeleteIssueLinkValidationResult	validateDelete(com.atlassian.crowd.embedded.api.User user, Issue issue, IssueLink issueLink) Validates parameters and checks permissions, and if all checks pass it will create a IssueLinkService.DeleteIssueLinkValidationResult that can be passed to the delete(DeleteIssueLinkValidationResult) method.

Method Detail

getIssueLinkTypes

Collection<IssueLinkType> getIssueLinkTypes()

Returns:

the all issue link types defined in JIRA

getIssueLink

IssueLink getIssueLink(Long sourceId,
                       Long destinationId,
                       Long issueLinkTypeId)

Returns the issue link or null if not found.

Parameters:

sourceId - source issue id of the link

destinationId - destination issue id of the link

issueLinkTypeId - link type id of the link

Returns:

issue link or null if not found

getIssueLink

IssueLinkService.SingleIssueLinkResult getIssueLink(Long issueLinkId,
                                                    com.atlassian.crowd.embedded.api.User user)

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

IssueLinkService.IssueLinkResult getIssueLinks(com.atlassian.crowd.embedded.api.User user,
                                               Issue issue)

Returns the issue links that the specified user can see. Will only return non-system (user-defined) links.

Parameters:

user - The user performing the operation

issue - The issue that links will retrieved on

Returns:

a result that contains the issue links

getIssueLinks

IssueLinkService.IssueLinkResult getIssueLinks(com.atlassian.crowd.embedded.api.User user,
                                               Issue issue,
                                               boolean excludeSystemLinks)

Parameters:

user - The user performing the operation

issue - The issue that links will retrieved on

excludeSystemLinks - 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(com.atlassian.crowd.embedded.api.User 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 operation

issue - The issue that links will be set on

linkName - The actual link name as strings to set on the issue

linkKeys - 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(com.atlassian.crowd.embedded.api.User user,
                                                                    Issue issue,
                                                                    Long issueLinkTypeId,
                                                                    Direction direction,
                                                                    Collection<String> linkKeys,
                                                                    boolean excludeSystemLinks)

Parameters:

user - The user performing the operation

issue - The issue that links will be set on

issueLinkTypeId - The actual link id to set on the issue

direction - which direction we are linking in

linkKeys - The collection of issue keys to link against

excludeSystemLinks - whether or not system links are okay

Returns:

a validation result, that can be used to set the labels or to display errors.

addIssueLinks

void addIssueLinks(com.atlassian.crowd.embedded.api.User user,
                   IssueLinkService.AddIssueLinkValidationResult result)

Adds the issue link to the issue specified by the validation result.

Parameters:

user - The user performing the operation

result - 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(com.atlassian.crowd.embedded.api.User user,
                                                                Issue issue,
                                                                IssueLink issueLink)

Validates parameters and checks permissions, and if all checks pass it will create a IssueLinkService.DeleteIssueLinkValidationResult that can be passed to the delete(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 from

issueLink - 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

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.

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 have ServiceResult.isValid() return true. If false this method will throw an IllegalStateException.