Enum Class LinkType

Method Details

• values

  public static LinkType[] values()

  Returns an array containing the constants of this enum class, in the order they are declared.

  Returns:

  an array containing the constants of this enum class, in the order they are declared

• valueOf

  public static LinkType valueOf(String name)

  Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  IllegalArgumentException - if this enum class has no constant with the specified name

  NullPointerException - if the argument is null

• supportedValues

  public static Collection<LinkType> supportedValues()

  Returns the link types that are supported, as determined by ProcessScope.

  Returns:

  the supported link types.

  Since:

  1.9.0

  See Also:

  • ProcessScope

• forAssociationType

  public static Collection<LinkType> forAssociationType(AssociationType associationType)

  Returns the supported link types for the given association type.

  Parameters:

  associationType - the association type

  Returns:

  the supported link types

• forSourceType

  public static Collection<LinkType> forSourceType(ResourceType sourceType)

  Returns the supported link types for the given source type.

  Parameters:

  sourceType - the source type (e.g: ResourceType.CHANGE_REQUEST or ResourceType.REQUIREMENT)

  Returns:

  the supported link types

  Since:

  3.5.0

• forSourceRange

  public static Collection<LinkType> forSourceRange(URI sourceRange)

  Returns the supported link types for the given source range.

  Parameters:

  sourceRange - the source range (e.g: OslcCm.TYPE_CHANGE_REQUEST, OslcAm.TYPE_AMRESOURCE, OslcRm.TYPE_REQUIREMENT...)

  Returns:

  the supported link types

• forPropertyDefinition

  public static Collection<LinkType> forPropertyDefinition(URI propertyDefinition)

  Returns the supported link types for the given property definition.

  Parameters:

  propertyDefinition - the link type property definition

  Returns:

  the corresponding link types

• forDeliverableType

  public static Collection<LinkType> forDeliverableType(DeliverableType deliverableType)

  Returns the supported link types matching the given deliverable type.

  Parameters:

  deliverableType - the deliverable type to match

  Returns:

  the supported link types

  Since:

  1.8.0

• getDirection

  public static LinkType.Direction getDirection(URI propertyDefinition)

  Returns the link type direction for the given property definition.

  Note that while a property definition may have several corresponding link types, they will always be in the same direction.

  Parameters:

  propertyDefinition - the link type property definition

  Returns:

  the link type direction

• getDeliverableType

  public static Optional<DeliverableType> getDeliverableType(URI propertyDefinition)

  Returns the link type default deliverable type for the given property definition.

  Deliverable types only apply to link types between a CM resource and another configurable domain (AM, QM, RM...). Other link types will return an empty optional.

  Parameters:

  propertyDefinition - the link type property definition

  Returns:

  the link type default deliverable type

  Since:

  1.8.0

• getTitle

  public static String getTitle(URI propertyDefinition, List<Locale> locales)

  Returns the link type title for the given property definition.

  Note that while a property definition may have several corresponding link types, they will always have the same title.

  Parameters:

  propertyDefinition - the link type property definition

  locales - the locales preferences to translate the title

  Returns:

  the link type title

• getUsagePropertyDefinition

  @Deprecated(since="4.2.0", forRemoval=true) public static URI getUsagePropertyDefinition(String usages)

  Deprecated, for removal: This API element is subject to removal in a future version.

  use getLinkTypesFromUsage(String, OslcNamespaces)

  Gets the property definition (URI) of an usages value. A usage is commonly sent by ELM applications when opening a selection/creation dialog, to inform the remote application of the link type the dialog was opened for. It consists of a prefixed link type property, such as oslc_cm:relatedChangeRequest.

  Parameters:

  usages - the usages value.

  Returns:

  the corresponding URI.

  Throws:

  IllegalArgumentException - if usages cannot be resolved to a valid instance of this class.

• getLinkTypesFromUsage

  public static List<LinkType> getLinkTypesFromUsage(String usage, OslcNamespaces namespaces)

  Parses a linking oslc:usage into a collection of supported LinkType constants.

  Remote applications may send an oslc:usage query parameter when opening a linking dialog (selection or creation). This parameter is a semicolon-separated list of namespace-prefixed link types, e.g., oslc:usage=oslc_qm:testsChangeRequest;oslc_rm:implementedBy, that specifies the intended link type(s) to create when the dialog selection/creation completes. Typically, a single link type is specified, but ETM has been observed to send all the link types that it will create, in cascade, in the different involved applications for a test case (as showed in the example above).

  Knowing the link type that will be created after the selection/creation is useful, for a Change Management application for example, to determine the Deliverable field that must be used to match a Global Configuration, if any.

  This method parses the LinkType constants in the order they are specified in the query parameter, and uses a scoping OslcNamespaces instance to resolve the prefixed namespaces.

  Parameters:

  usage - the oslc:usage parameter value.

  namespaces - the scoping OslcNamespaces instance.

  Returns:

  an empty list if usage is null or empty; the matching supporting LinkType instances otherwise.

  Throws:

  NullPointerException - if namespaces is null.

  Since:

  4.2.0

• getAssociationType

  @Deprecated(since="3.7.0", forRemoval=false) public AssociationType getAssociationType()

  Deprecated.

  use getAssociationTypes() instead, as link types can belong to multiple association types.

  Gets the association type this link belongs to.

  Returns:

  the association type this link type belongs to.

• getAssociationTypes

  public Collection<AssociationType> getAssociationTypes()

  Gets the association types this link belongs to.

  Returns:

  the association types this link type belongs to.

  Since:

  3.7.0

• getPropertyDefinition

  public URI getPropertyDefinition()

• getTitle

  public String getTitle(List<Locale> locales)

• getSourceType

  public ResourceType getSourceType()

  Returns the source type of the link type

  Returns:

  the source type

  Since:

  3.5.0

• getSourceRange

  public URI getSourceRange()

• getTargetType

  public ResourceType getTargetType()

  Returns the target type of the link type

  Returns:

  the target type

  Since:

  3.5.0

• getTargetRange

  public URI getTargetRange()

• getDirection

  public LinkType.Direction getDirection()

• getBacklink

  public Optional<LinkType> getBacklink()

• getDeliverableType

  public Optional<DeliverableType> getDeliverableType()

  Returns the link type's default deliverable type.

  Deliverable types only apply to link types between a CM resource and another configurable domain (AM, QM, RM...). Other link types will return an empty optional.

  Returns:

  the link type's default deliverable type

  Since:

  1.8.0

• isUserSelectable

  public boolean isUserSelectable()

  Determines whether the end-user must be offered to create a link of such type. Most of the link types can be initiated by the end-user on his local resource, but some can only be created from the opposite bound, typically the tracksChangeSet one.

  Returns:

  true if the end-user can create such link on his local resource, false otherwise.

  Since:

  3.3.1

• isNonStorableLink

  public static boolean isNonStorableLink(URI linkType)

  Determines whether the link type is only present to be able to display a link title and should never be stored.

  Parameters:

  linkType - Property definition of the LinkType.

  Returns:

  true if the link type should never be stored, false otherwise.

  Since:

  3.13.0