Summary: Methods | [Expand All]
@PublicApi public interface

LinkCollection

com.atlassian.jira.issue.link.LinkCollection
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This class represents the collection of links in to and out of a particular issue.

Sort order is determined by the application property "jira.view.issue.links.sort.order"

Summary

Public Methods
Collection<Issue> getAllIssues()
Returns a collection of issues that contains both inward and outward linking issues.
@Nullable List<Issue> getInwardIssues(String linkName)
Looks up and returns a "sort.order" sorted list of all inward linked issues by given link name.
Set<IssueLinkType> getLinkTypes()
Returns a set of link types, IssueLinkType objects.
@Nullable List<Issue> getOutwardIssues(String linkName)
Looks up and returns a "sort.order" sorted list of all outward linked issues by given link name.
boolean isDisplayLinkPanel()
This method is deprecated. No longer relevant because of introduction of Remote Issue Links. Since v5.0.

Public Methods

public Collection<Issue> getAllIssues ()

Returns a collection of issues that contains both inward and outward linking issues. The returned collection is sorted by "sort.order" and does not contain duplicates.

Returns
  • a collection of all linked issues

@Nullable public List<Issue> getInwardIssues (String linkName)

Looks up and returns a "sort.order" sorted list of all inward linked issues by given link name. May return null.

Parameters
linkName link name to lookup issues by
Returns
  • a sorted list of browsable inward linked issues

public Set<IssueLinkType> getLinkTypes ()

Returns a set of link types, IssueLinkType objects.

Returns

@Nullable public List<Issue> getOutwardIssues (String linkName)

Looks up and returns a "sort.order" sorted list of all outward linked issues by given link name. May return null.

Parameters
linkName link name to lookup issues by
Returns
  • a sorted list of browsable outward linked issues or null (sorry)

public boolean isDisplayLinkPanel ()

This method is deprecated.
No longer relevant because of introduction of Remote Issue Links. Since v5.0.

Determine whether there are links visible to this user - do not display link panel if not

Returns
  • true if there are any outward or inward links, false otherwise