public interface

EntityLink

implements PropertySet
com.atlassian.applinks.api.EntityLink
Known Indirect Subclasses

Class Overview

Represents a link to a remote entity (Project, Space, Repository, etc).

Summary

Public Methods
abstract ApplicationLink getApplicationLink()
abstract URI getDisplayUrl()
abstract String getKey()
abstract String getName()
abstract EntityType getType()
abstract boolean isPrimary()
[Expand]
Inherited Methods
From interface com.atlassian.applinks.api.PropertySet

Public Methods

public abstract ApplicationLink getApplicationLink ()

Returns
  • the link to the application that houses this entity

public abstract URI getDisplayUrl ()

Returns
  • the display URL for this entity (e.g. http://jira.atlassian.com/browse/JRA) or null if there is no displayable url.

public abstract String getKey ()

Returns
  • the remote project-level entity key (e.g. JRA, JIRAEXT)

public abstract String getName ()

Returns
  • the name of the remote entity (e.g. "My JIRA Project", "My FishEye Repository"), or the value of getKey() if no name is configured

public abstract EntityType getType ()

Returns
  • the type of the entity

public abstract boolean isPrimary ()

Returns
  • true if this is the primary link of its type for the local entity context