com.atlassian.jira.issue.link
Interface RemoteLinkManager

All Known Implementing Classes:

DefaultRemoteLinkManager

public interface RemoteLinkManager

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

Since:

v5.0

Method Summary

RemoteLink	createRemoteLink(RemoteLink remoteLink, com.atlassian.crowd.embedded.api.User user) Creates the given remote link.
RemoteLink	getRemoteLink(Long remoteLinkId) Returns the remote link with the given id, or null if it does not exist.
Iterable<RemoteLink>	getRemoteLinksForIssue(Issue issue) Gets the remote links that link with the given JIRA issue.
void	removeRemoteLink(Long remoteLinkId, com.atlassian.crowd.embedded.api.User user) Deletes the given remote link id.
void	updateRemoteLink(RemoteLink remoteLink, com.atlassian.crowd.embedded.api.User user) Updates the given remote link.

Method Detail

getRemoteLink

RemoteLink getRemoteLink(Long remoteLinkId)

Returns the remote link with the given id, or null if it does not exist.

Parameters:

remoteLinkId - the id of the remote link to get

Returns:

the remote link with the given id

getRemoteLinksForIssue

Iterable<RemoteLink> getRemoteLinksForIssue(Issue issue)

Gets the remote links that link with the given JIRA issue.

Parameters:

issue - the issue to get the remote links for

Returns:

the remote links for the given issue

createRemoteLink

RemoteLink createRemoteLink(RemoteLink remoteLink,
                            com.atlassian.crowd.embedded.api.User user)
                            throws CreateException

Creates the given remote link.

Parameters:

remoteLink - the remote link to create

user - the current user

Returns:

the id of the created remote link

Throws:

CreateException

updateRemoteLink

void updateRemoteLink(RemoteLink remoteLink,
                      com.atlassian.crowd.embedded.api.User user)
                      throws UpdateException

Updates the given remote link. The remote 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:

remoteLink - the remote link to update

user - the current user

Throws:

UpdateException

removeRemoteLink

void removeRemoteLink(Long remoteLinkId,
                      com.atlassian.crowd.embedded.api.User user)
                      throws RemoveException

Deletes the given remote link id.

Parameters:

remoteLinkId - the id of the remote link to delete

user - the current user

Throws:

RemoveException