com.atlassian.applinks.api
Interface EntityLink

All Superinterfaces:

PropertySet

public interface EntityLink
extends PropertySet

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

Since:

3.0

Method Summary

ApplicationLink	getApplicationLink()
URI	getDisplayUrl()
String	getKey()
String	getName()
EntityType	getType()
boolean	isPrimary()

Methods inherited from interface com.atlassian.applinks.api.PropertySet

getProperty, putProperty, removeProperty

Method Detail

getApplicationLink

ApplicationLink getApplicationLink()

Returns:

the link to the application that houses this entity

getType

EntityType getType()

Returns:

the type of the entity

getKey

String getKey()

Returns:

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

getName

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

getDisplayUrl

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.

isPrimary

boolean isPrimary()

Returns:

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