Interface WithMetadata

All Superinterfaces:
WithLinks, WithParameters
All Known Implementing Classes:
ScopeResult, TestResult

public interface WithMetadata extends WithLinks, WithParameters
The interface for model objects that carry test metadata: labels, links, parameters, and description.

Shared by TestResult and ScopeResult so runtime APIs can apply metadata to whichever is the current target without branching on the concrete type.

Since:
3.0
See Also:
  • Method Details

    • getLabels

      List<Label> getLabels()
      Gets labels.
      Returns:
      the labels
    • getDescription

      String getDescription()
      Gets description.
      Returns:
      the description
    • setDescription

      WithMetadata setDescription(String value)
      Sets description.
      Parameters:
      value - the description
      Returns:
      self for chaining
    • getDescriptionHtml

      String getDescriptionHtml()
      Gets HTML description.
      Returns:
      the HTML description
    • setDescriptionHtml

      WithMetadata setDescriptionHtml(String value)
      Sets HTML description.
      Parameters:
      value - the HTML description
      Returns:
      self for chaining