com.atlassian.jira.issue.link
Class LinkCollection

java.lang.Object
  extended by com.atlassian.jira.issue.link.LinkCollection

public class LinkCollection
extends Object

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


Constructor Summary
LinkCollection(org.ofbiz.core.entity.GenericValue issue, Set linkTypes, Map outwardLinkMap, Map inwardLinkMap, User remoteUser, ApplicationProperties applicationProperties)
          Creates a new instance of this class.
 
Method Summary
 Collection getAllIssues()
          Returns a collection of issues that contains both inward and outward linking issues.
 List getInwardIssues(String linkName)
          Looks up and returns a SORT_ORDER sorted list of all inward linked issues by given link name.
 Set getLinkTypes()
          Returns a set of link types, IssueLinkType objects.
 List getOutwardIssues(String linkName)
          Looks up and returns a SORT_ORDER sorted list of all outward linked issues by given link name.
 boolean isDisplayLinkPanel()
          Determine whether there are links visible to this user - do not display link panel if not
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinkCollection

public LinkCollection(org.ofbiz.core.entity.GenericValue issue,
                      Set linkTypes,
                      Map outwardLinkMap,
                      Map inwardLinkMap,
                      User remoteUser,
                      ApplicationProperties applicationProperties)
Creates a new instance of this class. Sort order can be specified in the application properties under APKeys.JIRA_VIEW_ISSUE_LINKS_SORT_ORDER key.

Parameters:
issue - issue generic value this link collection relates to
linkTypes - a set of link types
outwardLinkMap - a map of outward links
inwardLinkMap - a map of inward links
remoteUser - user, set but not used
applicationProperties - application properties
Method Detail

getLinkTypes

public Set getLinkTypes()
Returns a set of link types, IssueLinkType objects.

Returns:
a set of IssueLinkType objects

getOutwardIssues

public List 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

getInwardIssues

public List 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

getAllIssues

public Collection 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

isDisplayLinkPanel

public boolean isDisplayLinkPanel()
Determine whether there are links visible to this user - do not display link panel if not

Returns:
true is there are any outward or inward links, false otherwisel


Copyright © 2002-2008 Atlassian. All Rights Reserved.