com.adaptavist.tm4j.api.service.status

Interface StatusService

public interface StatusService

Responsible for all management of StatusModel within TM4J.

Method Summary

Modifier and Type	Method and Description
ServiceResult<TestCaseStatusModel>	getTestCaseStatusModelById(String userKey, Long statusId) Retrieves the TestCaseStatus as a TestCaseStatusModel with the given statusId.
ServiceResult<TestCycleStatusModel>	getTestCycleStatusModelById(String userKey, Long statusId) Retrieves the TestCycleStatus as a TestCycleStatusModel with the given statusId.
ServiceResult<TestExecutionStatusModel>	getTestExecutionStatusModelById(String userKey, Long statusId) Retrieves the TestExecutionStatus as a TestExecutionStatusModel with the given statusId.

Method Detail

getTestCaseStatusModelById

ServiceResult<TestCaseStatusModel> getTestCaseStatusModelById(String userKey,
                                                              Long statusId)

Retrieves the TestCaseStatus as a TestCaseStatusModel with the given statusId.

Parameters:

userKey - an identifier that uniquely identifies a user which is performing the action.

statusId - the ID of the Test Case.

Returns:

a ServiceResult containing a TestCaseStatusModel with the relevant fields of the TestCaseStatus. 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

getTestCycleStatusModelById

ServiceResult<TestCycleStatusModel> getTestCycleStatusModelById(String userKey,
                                                                Long statusId)

Retrieves the TestCycleStatus as a TestCycleStatusModel with the given statusId.

Parameters:

userKey - an identifier that uniquely identifies a user which is performing the action.

statusId - the ID of the Test Cycle.

Returns:

a ServiceResult containing a TestCycleStatusModel with the relevant fields of the TestCycleStatus. 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

getTestExecutionStatusModelById

ServiceResult<TestExecutionStatusModel> getTestExecutionStatusModelById(String userKey,
                                                                        Long statusId)

Retrieves the TestExecutionStatus as a TestExecutionStatusModel with the given statusId.

Parameters:

userKey - an identifier that uniquely identifies a user which is performing the action.

statusId - the ID of the Test Execution.

Returns:

a ServiceResult containing a TestExecutionStatusModel with the relevant fields of the TestExecutionStatus 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