Package com.adaptavist.tm4j.api.service.tracelink

Interface TraceLinkService

public interface TraceLinkService
Responsible for all management of TraceLink entities within Zephyr Scale.

  • Method Details

    • getTraceLinkModelsByTestCaseId

      ServiceResult<List<TraceLinkModel>> getTraceLinkModelsByTestCaseId(String userKey, Long testCaseId)
      Returns a List of TraceLinkModel related to a given testCaseId.
      Parameters:
      userKey - an identifier that uniquely identifies a user which is performing the action.
      testCaseId - the id of the Test Case.
      Returns:
      a ServiceResult containing a List of TraceLinkModel with the TraceLinks related to the testCaseId. The result will also contains a ValidationResult that will contain any validation messages that may have been generated when performing the operation.
      Since:
      6.8.0

    • getTraceLinkModelsByTestCycleId

      ServiceResult<List<TraceLinkModel>> getTraceLinkModelsByTestCycleId(String userKey, Long testCycleId)
      Returns a List of TraceLinkModel related to a given testCycleId.
      Parameters:
      userKey - an identifier that uniquely identifies a user which is performing the action.
      testCycleId - the id of the Test Cycle.
      Returns:
      a ServiceResult containing a List of TraceLinkModel with the TraceLinks related to the testCycleId. The result will also contains a ValidationResult that will contain any validation messages that may have been generated when performing the operation.
      Since:
      6.8.0

    • getTraceLinkModelsByTestExecutionId

      ServiceResult<List<TraceLinkModel>> getTraceLinkModelsByTestExecutionId(String userKey, Long testExecutionId)
      Returns a List of TraceLinkModel related to a given testExecutionId.
      Parameters:
      userKey - an identifier that uniquely identifies a user which is performing the action.
      testExecutionId - the id of the Test Execution.
      Returns:
      a ServiceResult containing a List of TraceLinkModel with the TraceLinks related to the testExecutionId. The result will also contains a ValidationResult that will contain any validation messages that may have been generated when performing the operation.
      Since:
      6.8.0

    • getTestCaseTraceLinkCountByIssueId

      ServiceResult<Long> getTestCaseTraceLinkCountByIssueId(String userKey, Long issueId)
      Returns the number of TraceLinks between an Issue and TestCase that exist for the provided issueId.
      Parameters:
      userKey - an identifier that uniquely identifies a user which is performing the action.
      issueId - the id of the Issue.
      Returns:
      a ServiceResult containing a Long with the number of TraceLinks between an Issue and the TestCases that exist for the provided issueId. The result will also contains a ValidationResult that will contain any validation messages that may have been generated when performing the operation.
      Since:
      6.8.0