Package com.polarion.alm.shared.api.model.rt

Interface LinkedResourcePositionField

All Superinterfaces:
CanBeCustomField, CanRender<Renderer<? extends Renderer<?>>>, Field, ScalarField<String>, StringField
public interface LinkedResourcePositionField extends StringField
The "position" varies depending on the source file being parsed and the selected parser creating the resource traceability link.
For example, for a custom parser for .ppt files, "position" could mean the slide number and would therefore require a different message to be rendered.
For the provided Java, C and XML parsers "position" refers to the line number in the source file.
Since:
3.17.0

  • Method Details

    • render

      @NotNull LinkedResourcePositionRenderer render()
      Description copied from interface: Field
      This method can be used also when the parent object is unresolvable or user has no permission to access. In both cases the method will just render nothing and not throw any exceptions.
      Specified by:
      render in interface CanRender<Renderer<? extends Renderer<?>>>
      Specified by:
      render in interface Field
      Returns:
      the renderer that can be used to render both the position value and the message associated with it.
      See Also:

    • getLineNumber

      @Nullable String getLineNumber()
      Returns:
      the collected position if it has a value that refers to a line position inside a text file. (Decided by RtParserDescriptor.providesTextFileLineNumber()). Otherwise null is returned.