@PublicApi public final class RemoteIssueLink extends Object
RemoteIssueLinkBuilder
Modifier and Type | Field and Description |
---|---|
static String |
APPLICATION_TYPE_CONFLUENCE |
static String |
APPLICATION_TYPE_JIRA |
Constructor and Description |
---|
RemoteIssueLink(Long id,
Long issueId,
String globalId,
String title,
String summary,
String url,
String iconUrl,
String iconTitle,
String relationship,
Boolean resolved,
String statusIconUrl,
String statusIconTitle,
String statusIconLink,
String applicationType,
String applicationName) |
RemoteIssueLink(Long id,
Long issueId,
String globalId,
String title,
String summary,
String url,
String iconUrl,
String iconTitle,
String relationship,
Boolean resolved,
String statusIconUrl,
String statusIconTitle,
String statusIconLink,
String applicationType,
String applicationName,
String statusName,
String statusDescription,
String statusCategoryKey,
String statusCategoryColorName) |
Modifier and Type | Method and Description |
---|---|
String |
getApplicationName()
Returns the human-readable name of the remote application instance that contains the remote object.
|
String |
getApplicationType()
Returns the type of remote application that we are linking with.
|
String |
getGlobalId()
Returns a String which uniquely identifies the object in the remote application.
|
String |
getIconTitle()
Returns the tool tip text for the
icon . |
String |
getIconUrl()
Returns a url for an icon to represent the remote object.
|
Long |
getId()
Returns the id of the link.
|
Long |
getIssueId()
Returns the id of the issue we are linking with.
|
String |
getRelationship()
Returns a String which describes the relationship between the JIRA issue and the remote object.
|
String |
getStatusCategoryColorName() |
String |
getStatusCategoryKey() |
String |
getStatusDescription() |
String |
getStatusIconLink()
Returns a hyperlink for the
status icon . |
String |
getStatusIconTitle()
Returns the tool tip text for the
status icon . |
String |
getStatusIconUrl()
Returns a url for an icon representing the status of the remote object.
|
String |
getStatusName() |
String |
getSummary()
Returns a summary of the remote object.
|
String |
getTitle()
Returns a String to identify the remote object.
|
String |
getUrl()
Returns a url to the object in the remote application.
|
boolean |
hasStatusCategory() |
Boolean |
isResolved()
Returns a Boolean to indicate whether the remote object is resolved or not.
|
public static String APPLICATION_TYPE_JIRA
public static String APPLICATION_TYPE_CONFLUENCE
public RemoteIssueLink(Long id, Long issueId, String globalId, String title, String summary, String url, String iconUrl, String iconTitle, String relationship, Boolean resolved, String statusIconUrl, String statusIconTitle, String statusIconLink, String applicationType, String applicationName)
public RemoteIssueLink(Long id, Long issueId, String globalId, String title, String summary, String url, String iconUrl, String iconTitle, String relationship, Boolean resolved, String statusIconUrl, String statusIconTitle, String statusIconLink, String applicationType, String applicationName, String statusName, String statusDescription, String statusCategoryKey, String statusCategoryColorName)
public Long getId()
public Long getIssueId()
public String getGlobalId()
For simplicity, this could simply be the url
, although this is not wise if there is a chance
the url may change.
This value is not displayed in the JIRA user interface. We suggest including in this field any values that will be needed by a renderer plugin, for example the application url and remote object identifier to make REST calls.
For example: "url=http://www.myapplication.com&ticketid=12345"
public String getTitle()
url
in the
JIRA user interface.
For example: a JIRA issue key, a Confluence page title, a helpdesk ticket number
public String getSummary()
title
in the JIRA user
interface.
For example: a JIRA issue summary, a helpdesk ticket title
public String getUrl()
For example: a confluence page url
public String getIconUrl()
For example: http://mycompany.com/jira/images/icons/bug.png
public String getIconTitle()
icon
. The applicationName
is prepended to this value to form the icon tool tip text.
For example: "Bug - A problem which impairs or prevents the functions of the product"
icon
public String getRelationship()
For example: "relates to", "is mentioned in", "links to". It could even be a simple noun, such as "Test Case".
public Boolean isResolved()
If the value is true, the remote issue link be shown in a strikethrough font in the user interface.
public String getStatusIconUrl()
summary
in the JIRA user interface, and is right
justified. This icon does not have to strictly represent a "status", and may instead represent some secondary
information about the link.
For example: the status of a JIRA issue, the author of a test case
public String getStatusIconTitle()
status icon
. If null, no tool tip text is shown.
This value is not used if the statusIconUrl
is null.status icon
public String getStatusIconLink()
status icon
. If null, no hyperlink is shown. This value
is not used if the statusIconUrl
is null.status icon
public String getApplicationType()
applicationName
in the user interface.
Renderering plugins can register to render a certain type of application. It is not possible to use a plugin to render links without an applicationType.
For example: "com.atlassian.confluence", "com.mycompany.myproduct"
public String getApplicationName()
applicationType
and applicationName in the user interface.
The applicationName is prepended to the iconTitle
to form the icon tool tip text.
For example: "My Company's Confluence", "HR JIRA", "Helpdesk JIRA"
public String getStatusName()
public String getStatusDescription()
public String getStatusCategoryKey()
public String getStatusCategoryColorName()
public boolean hasStatusCategory()
Copyright © 2002-2022 Atlassian. All Rights Reserved.