@ExperimentalApi public interface

RemoteEntityLink

com.atlassian.jira.entity.remotelink.RemoteEntityLink<E>
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Common abstract class for remote entity links.

Summary

Constants
String GLOBAL_ID The name of the JSON object field that may be used to suggest the global ID to use when creating a remote entity link.
Public Methods
@Nullable String getApplicationName()
Returns the application name for the remote entity link, as extracted from the raw JSON.
@Nullable String getApplicationType()
Returns the application type for the remote entity link, as extracted from the raw JSON.
E getEntity()
Returns the local entity to which the remote entity link is associated.
@Nonnull Long getEntityId()
Returns the entity ID for the local entity to which the remote entity link is associated.
@Nonnull String getGlobalId()
Returns the global ID for the remote entity link.
@Nullable String getIconTitle()
Returns the target object icon title for the remote entity link, as extracted from the raw JSON.
@Nullable String getIconUrl()
Returns the target object icon URL for the remote entity link, as extracted from the raw JSON.
@Nonnull String getJsonString()
Returns the raw JSON value stored for this remote entity link.
@Nullable String getSummary()
Returns the target object summary for the remote entity link, as extracted from the raw JSON.
@Nullable String getTitle()
Returns the target object title for the remote entity link, as extracted from the raw JSON.
@Nullable String getUrl()
Returns the target object URL for the remote entity link, as extracted from the raw JSON.

Constants

public static final String GLOBAL_ID

The name of the JSON object field that may be used to suggest the global ID to use when creating a remote entity link. The services that create remote entity links accept a global ID and the raw JSON value meaningful to the link service. If the global ID is not specified directly but the JSON value is an object containing a text field by this name ("{@value }"), that value is used as the global ID. If neither method of supplying the global ID is used, then a random global ID will be generated for the link, instead.

See RemoteVersionLinkService for an example of this.

Constant Value: "globalId"

Public Methods

@Nullable public String getApplicationName ()

Returns the application name for the remote entity link, as extracted from the raw JSON.

Returns
  • the application name for the remote entity link, or null if it is not defined

@Nullable public String getApplicationType ()

Returns the application type for the remote entity link, as extracted from the raw JSON.

Returns
  • the application type for the remote entity link, or null if it is not defined

public E getEntity ()

Returns the local entity to which the remote entity link is associated. For example, if this is a RemoteVersionLink, then this will return a Version.

Returns
  • the local entity to which the remote entity link is associated.

@Nonnull public Long getEntityId ()

Returns the entity ID for the local entity to which the remote entity link is associated. For example, if this is a RemoteVersionLink, then this will be a version ID.

Returns
  • the entity ID for the local entity to which the remote entity link is associated.

@Nonnull public String getGlobalId ()

Returns the global ID for the remote entity link.

Returns
  • the global ID for the remote entity link.

@Nullable public String getIconTitle ()

Returns the target object icon title for the remote entity link, as extracted from the raw JSON.

Returns
  • the target object icon title for the remote entity link, or null if it is not defined

@Nullable public String getIconUrl ()

Returns the target object icon URL for the remote entity link, as extracted from the raw JSON.

Returns
  • the target object icon URL for the remote entity link, or null if it is not defined

@Nonnull public String getJsonString ()

Returns the raw JSON value stored for this remote entity link.

Returns
  • the raw JSON value stored for this remote entity link.

@Nullable public String getSummary ()

Returns the target object summary for the remote entity link, as extracted from the raw JSON.

Returns
  • the target object summary for the remote entity link, or null if it is not defined

@Nullable public String getTitle ()

Returns the target object title for the remote entity link, as extracted from the raw JSON.

Returns
  • the target object title for the remote entity link, or null if it is not defined

@Nullable public String getUrl ()

Returns the target object URL for the remote entity link, as extracted from the raw JSON.

Returns
  • the target object URL for the remote entity link, or null if it is not defined