Package com.siemens.polarion.rt.parsers.api

Interface RtLinkBuilder

public interface RtLinkBuilder

The builder for creating link objects RtLink.

Since:

3.17.0

Method Summary

Modifier and Type	Method	Description
RtLinkBuilder	message(String message)	Sets value for RtLink.getMessage()
RtLinkBuilder	position(RtPosition position)	Sets value for RtLink.getPosition()
RtLinkBuilder	role(String role)	Sets value for RtLink.getRole()
RtLink	workItem(String projectId, String workItemId, String revision)	Sets Work Item reference for RtLink.getObjectReference().

Method Details

position

@NotNull
RtLinkBuilder position(@NotNull
 RtPosition position)

Sets value for RtLink.getPosition()

workItem

@NotNull
RtLink workItem(@NotNull
 String projectId,
 @NotNull
 String workItemId,
 @Nullable
 String revision)

Sets Work Item reference for RtLink.getObjectReference(). This method should be invoked as a last step.

Parameters:

projectId - the project that contains the Work Item.

workItemId - the id of the referenced Work Item.

revision - the specific revision of a referenced Work Item or the latest revision if null is specified.

Returns:

the created link object.

role

@NotNull
RtLinkBuilder role(@NotNull
 String role)

Sets value for RtLink.getRole()

message

@NotNull
RtLinkBuilder message(@NotNull
 String message)

Sets value for RtLink.getMessage()