RtLink

public interface RtLink

The link object that references Polarion objects like Work Items from the source file.

Since:: 3.17.0

Method Summary

Modifier and Type

Method

Description

String

getMessage()

RtObjectReference

getObjectReference()

RtPosition

getPosition()

String

getRole()

Method Details
- getPosition
  
  @NotNull RtPosition getPosition()
  
  Returns:
  
  the position of the link inside the source file.
- getObjectReference
  
  @NotNull RtObjectReference getObjectReference()
  
  Returns:
  
  a Polarion object reference related to this link.
- getMessage
  
  @Nullable String getMessage()
  
  Returns:
  
  an optional message associated with the link.
- getRole
  
  @Nullable String getRole()
  
  Returns:
  
  a link role that represents the relation type between a Polarion object and an element in the source file. Typical usage is to denote how the element in the source file is connected to Work Items covered by the source code.