Summary: Methods | [Expand All]
@PublicApi public interface

IssueLinkTypeService

com.atlassian.jira.bc.issue.link.IssueLinkTypeService
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Service for creation, deletion, and general management of IssueLinkTypes. If Issue Linking is disabled, none of these will work.

Summary

Public Methods
ServiceOutcome<IssueLinkType> createIssueLinkType(ApplicationUser user, String name, String outward, String inward)
Create a new issue link type.
ServiceOutcome<IssueLinkType> deleteIssueLinkType(ApplicationUser user, IssueLinkType linkType)
Delete a given IssueLinkType, checking for permissions.
ServiceOutcome<Collection<IssueLinkType>> getIssueLinkTypes(ApplicationUser user)
Get a list of all issue link types in the system.
ServiceOutcome<IssueLinkType> updateIssueLinkType(ApplicationUser user, IssueLinkType linkType, String name, String outward, String inward)
Update an existing issue link type

Public Methods

public ServiceOutcome<IssueLinkType> createIssueLinkType (ApplicationUser user, String name, String outward, String inward)

Create a new issue link type.

Parameters
user the user who will create it
name the name of the link to create
outward the description to use for outbound links of this type
inward the description to use for inbound links of this type
Returns
  • a ServiceOutcome that contains a description of the failure or the created IssueLinkType

public ServiceOutcome<IssueLinkType> deleteIssueLinkType (ApplicationUser user, IssueLinkType linkType)

Delete a given IssueLinkType, checking for permissions.

Parameters
user the user who is performing the action
linkType the IssueLinkType to delete
Returns
  • a ServiceOutcome indicating success or failure

public ServiceOutcome<Collection<IssueLinkType>> getIssueLinkTypes (ApplicationUser user)

Get a list of all issue link types in the system.

Parameters
user the user who wants to know
Returns
  • a list of all issue link types

public ServiceOutcome<IssueLinkType> updateIssueLinkType (ApplicationUser user, IssueLinkType linkType, String name, String outward, String inward)

Update an existing issue link type

Parameters
user the user performing the modification
linkType the link you want to update
name the new name to use
outward the new outbound description to use
inward the new inbound description to use
Returns
  • the updated IssueLinkType