com.atlassian.jira.bc.issue.link

Interface IssueLinkTypeService

All Known Implementing Classes:

DefaultIssueLinkTypeService

@PublicApi
public interface IssueLinkTypeService

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

Since:

v6.0

Method Summary

Modifier and Type	Method and Description
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

Method Detail

createIssueLinkType

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

deleteIssueLinkType

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

getIssueLinkTypes

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

updateIssueLinkType

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