Package com.atlassian.jira.issue.link

Interface IssueLinkTypeManager

All Known Implementing Classes:
DefaultIssueLinkTypeManager
@PublicApi public interface IssueLinkTypeManager
Manages IssueLinkTypes.

  • Method Details

    • createIssueLinkType

      void createIssueLinkType(String name, String outward, String inward, String style)

    • updateIssueLinkType

      void updateIssueLinkType(IssueLinkType issueLinkType, String name, String outward, String inward)

    • removeIssueLinkType

      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. It simply removes the record from the datastore. Use IssueLinkTypeDestroyer to 'nicely' remove the issue link type taking care of existing issue links.
      Parameters:
      issueLinkTypeId - the id of the IssueLinkType to remove

    • getIssueLinkTypes

      Collection<IssueLinkType> getIssueLinkTypes()
      Returns only user-defined (non-system) IssueLinkType objects
      Returns:
      the collection

    • getIssueLinkTypes

      Collection<IssueLinkType> getIssueLinkTypes(boolean excludeSystemLinks)
      Parameters:
      excludeSystemLinks - whether or not to exclude system links
      Returns:
      the collection of IssueLinkType objects
      See Also:

    • getIssueLinkType

      IssueLinkType getIssueLinkType(Long id)
      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

      IssueLinkType getIssueLinkType(Long id, boolean excludeSystemLinks)
      Parameters:
      id - the id of the issue link type
      excludeSystemLinks - whether or not to exclude system links
      Returns:
      the issue link type object
      See Also:

    • getIssueLinkTypesByName

      Collection<IssueLinkType> getIssueLinkTypesByName(String name)
      Returns a collection of IssueLinkTypes 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 IssueLinkTypes, or an empty collection if name isn't a link type. TODO: Reconsider this method. The GUI enforces unique names.

    • getIssueLinkTypesByInwardDescription

      Collection<IssueLinkType> getIssueLinkTypesByInwardDescription(String desc)
      Returns a collection of IssueLinkTypes 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

      Collection<IssueLinkType> getIssueLinkTypesByOutwardDescription(String desc)
      Returns a collection of IssueLinkTypes 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

      Collection<IssueLinkType> getIssueLinkTypesByStyle(String style)

    • moveIssueLinkType

      void moveIssueLinkType(Long issueLinkTypeId, Long newSequence)
      Moves the issue link type to the new position.
      Parameters:
      issueLinkTypeId - the issue link type to move
      newSequence - the new position

    • resetOrderAlphabetically

      void resetOrderAlphabetically(String direction)
      This method resets the order of the issue link types alphabetically.
      Parameters:
      direction - Case-insensitive "asc" or "desc". If other, the default direction is ASC.