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

Interface LinkedResourceFields

All Superinterfaces:
Fields, Iterable<Field>, IterableWithSize<Field>
public interface LinkedResourceFields extends Fields
Since:
3.17.0

  • Method Details

    • role

      @NotNull StringField role()
      Returns:
      the role describing the association between the link and the defined Work Item.

    • fileName

      @NotNull StringField fileName()
      Returns:
      the name of the file where this link is found.

    • branch

      @NotNull StringField branch()
      Returns:
      the branch that the link was collected from.

    • location

      @NotNull StringField location()
      Returns:
      the location, relative to the repository root, that the link was collected from.

    • message

      @NotNull StringField message()
      Returns:
      the explanatory message, if any, about the link.

    • element

      @NotNull StringField element()
      Returns:
      the element that this link belongs to. For example: When using the provided Java parser, if the link is meant for a method, then this element returns the declaration of that method in the source file.

    • repositoryId

      @NotNull StringField repositoryId()
      Returns:
      the id of the repository, as it is used in the resource-traceability.xml and in the external repositories configuration.

    • parserId

      @NotNull StringField parserId()
      Returns:
      the id of the parser that created the link. As it is used in the resource-traceability.xml

    • category

      @NotNull StringField category()
      Returns:
      the repository category that this link belongs to. As it is used in the resource-traceability.xml

    • elementPosition

      @NotNull LinkedResourcePositionField elementPosition()
      Returns:
      the element's position within the source file.

    • linkPosition

      @NotNull LinkedResourcePositionField linkPosition()
      Returns:
      the link's position within the source file.

    • objectFromRevision

      @NotNull ModelObjectField objectFromRevision()
      Returns:
      the specific revision of the Work Item that the link was created for. (Based on the revision written in the source file.) If no revision is mentioned in the source file, then the current, head, revision of the object is returned.