com.atlassian.jira.issue.link
Interface RemoteIssueLinkManager

All Known Implementing Classes:
DefaultRemoteIssueLinkManager

@PublicApi
public interface RemoteIssueLinkManager

Manages remote issue links between a JIRA issue and remote objects in other remote applications.

Since:
v5.0

Method Summary
 RemoteIssueLink createRemoteIssueLink(RemoteIssueLink remoteIssueLink, com.atlassian.crowd.embedded.api.User user)
          Creates the given remote issue link.
 RemoteIssueLink getRemoteIssueLink(Long remoteIssueLinkId)
          Returns the remote issue link with the given id, or null if it does not exist.
 RemoteIssueLink getRemoteIssueLinkByGlobalId(Issue issue, String globalId)
          Returns the first remote issue link found that links with the given JIRA issue and has the given globalId, or null if none exists.
 List<RemoteIssueLink> getRemoteIssueLinksForIssue(Issue issue)
          Gets the remote issue links that link with the given JIRA issue.
 void removeRemoteIssueLink(Long remoteIssueLinkId, com.atlassian.crowd.embedded.api.User user)
          Deletes the given remote issue link id.
 void removeRemoteIssueLinkByGlobalId(Issue issue, String globalId, com.atlassian.crowd.embedded.api.User user)
          Deletes any remote issue link that links with the given JIRA issue and has the given global id.
 void updateRemoteIssueLink(RemoteIssueLink remoteIssueLink, com.atlassian.crowd.embedded.api.User user)
          Updates the given remote issue link.
 

Method Detail

getRemoteIssueLink

RemoteIssueLink getRemoteIssueLink(Long remoteIssueLinkId)
Returns the remote issue link with the given id, or null if it does not exist.

Parameters:
remoteIssueLinkId - the id of the remote issue link to get
Returns:
the remote issue link with the given id

getRemoteIssueLinksForIssue

List<RemoteIssueLink> getRemoteIssueLinksForIssue(Issue issue)
Gets the remote issue links that link with the given JIRA issue.

Parameters:
issue - the issue to get the remote issue links for
Returns:
the remote issue links for the given issue. This will never return null. If no remote issue links are stored against the issue, the list will be empty.

getRemoteIssueLinkByGlobalId

RemoteIssueLink getRemoteIssueLinkByGlobalId(Issue issue,
                                             String globalId)
Returns the first remote issue link found that links with the given JIRA issue and has the given globalId, or null if none exists.

Parameters:
issue - the issue to get the remote issue links for
globalId - the globalId to get the remote issue link for
Returns:
the remote issue link for the given issue with the given globalId

createRemoteIssueLink

RemoteIssueLink createRemoteIssueLink(RemoteIssueLink remoteIssueLink,
                                      com.atlassian.crowd.embedded.api.User user)
                                      throws CreateException
Creates the given remote issue link.

Parameters:
remoteIssueLink - the remote issue link to create
user - the current user
Returns:
the RemoteIssueLink object that was created including the generated id
Throws:
CreateException

updateRemoteIssueLink

void updateRemoteIssueLink(RemoteIssueLink remoteIssueLink,
                           com.atlassian.crowd.embedded.api.User user)
                           throws UpdateException
Updates the given remote issue link. The remote issue link is updated using all of the values in this object. Null values are written as null, and must adhere to the required field constraints.

Parameters:
remoteIssueLink - the remote issue link to update
user - the current user
Throws:
UpdateException

removeRemoteIssueLink

void removeRemoteIssueLink(Long remoteIssueLinkId,
                           com.atlassian.crowd.embedded.api.User user)
Deletes the given remote issue link id.

Parameters:
remoteIssueLinkId - the id of the remote issue link to delete
user - the current user

removeRemoteIssueLinkByGlobalId

void removeRemoteIssueLinkByGlobalId(Issue issue,
                                     String globalId,
                                     com.atlassian.crowd.embedded.api.User user)
Deletes any remote issue link that links with the given JIRA issue and has the given global id.

Parameters:
issue - the issue of the remote issue link
globalId - the global id of the remote issue link
user - the current user
Throws:
RemoveException - if the link could not be deleted


Copyright © 2002-2013 Atlassian. All Rights Reserved.