Package com.atlassian.jira.issue.link
Interface IssueLinkTypeManager
- All Known Implementing Classes:
DefaultIssueLinkTypeManager
@PublicApi
public interface IssueLinkTypeManager
Manages
IssueLinkType
s.-
Method Summary
Modifier and TypeMethodDescriptionvoid
createIssueLinkType
(String name, String outward, String inward, String style) getIssueLinkType
(Long id) Returns a user-defined (non-system) issue link type object for the specified ID.getIssueLinkType
(Long id, boolean excludeSystemLinks) Returns only user-defined (non-system) IssueLinkType objectsgetIssueLinkTypes
(boolean excludeSystemLinks) Returns a collection ofIssueLinkType
s with the given description as the inward description.Returns a collection ofIssueLinkType
s with the given name.Returns a collection ofIssueLinkType
s with the given description as the outward description.getIssueLinkTypesByStyle
(String style) void
removeIssueLinkType
(Long issueLinkTypeId) This method removed the issue link type from the database
WARNING: This method DOES NOT check if there are any existing issue links of this issue link type.void
updateIssueLinkType
(IssueLinkType issueLinkType, String name, String outward, String inward)
-
Method Details
-
createIssueLinkType
-
updateIssueLinkType
-
removeIssueLinkType
This method removed the issue link type from the database
WARNING: This method DOES NOT check if there are any existing issue links of this issue link type. It simply removes the record from the datastore. UseIssueLinkTypeDestroyer
to 'nicely' remove the issue link type taking care of existing issue links.- Parameters:
issueLinkTypeId
- the id of theIssueLinkType
to remove
-
getIssueLinkTypes
Collection<IssueLinkType> getIssueLinkTypes()Returns only user-defined (non-system) IssueLinkType objects- Returns:
- the collection
-
getIssueLinkTypes
- Parameters:
excludeSystemLinks
- whether or not to exclude system links- Returns:
- the collection of IssueLinkType objects
- See Also:
-
getIssueLinkType
Returns a user-defined (non-system) issue link type object for the specified ID.- Parameters:
id
- the id- Returns:
- the issue link type object
-
getIssueLinkType
- Parameters:
id
- the id of the issue link typeexcludeSystemLinks
- whether or not to exclude system links- Returns:
- the issue link type object
- See Also:
-
getIssueLinkTypesByName
Returns a collection ofIssueLinkType
s with the given name. Actually this collection should always have either one or zero elements - it is illegal to have two link types with the same name.- Parameters:
name
- The name to search for Issue Link Types by.- Returns:
- a collection of
IssueLinkType
s, or an empty collection ifname
isn't a link type. TODO: Reconsider this method. The GUI enforces unique names.
-
getIssueLinkTypesByInwardDescription
Returns a collection ofIssueLinkType
s with the given description as the inward description.There is no restriction on inward and outward descriptions being unique across issue link types, which is why this may return more than one
IssueLinkType
.- Parameters:
desc
- the inward description to search on- Returns:
- the collection of matched issue link types; never null.
- Since:
- v4.0
-
getIssueLinkTypesByOutwardDescription
Returns a collection ofIssueLinkType
s with the given description as the outward description.There is no restriction on inward and outward descriptions being unique across issue link types, which is why this may return more than one
IssueLinkType
.- Parameters:
desc
- the outward description to search on- Returns:
- the collection of matched issue link types; never null.
- Since:
- v4.0
-
getIssueLinkTypesByStyle
-