org.qas.qtest.api.services.design

Class TestDesignServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

org.qas.qtest.api.internal.QTestApiWebServiceClient<TestDesignServiceClient>

org.qas.qtest.api.services.design.TestDesignServiceClient

All Implemented Interfaces:

QTestService, TestDesignService

Direct Known Subclasses:

TestDesignServiceAsyncClient

public class TestDesignServiceClient
extends QTestApiWebServiceClient<TestDesignServiceClient>
implements TestDesignService

TestDesignServiceClient

Since:

1.0

Field Summary

Fields inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

credentialsProvider, exceptionUnmarshallers, executorService, signer

Fields inherited from class org.qas.api.ApiWebServiceClient

client, configuration, endpoint, requestHandlers, timeOffset

Constructor Summary

Constructors

Constructor and Description
TestDesignServiceClient() Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.
TestDesignServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.
TestDesignServiceClient(QTestCredentials credentials) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.
TestDesignServiceClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.
TestDesignServiceClient(QTestCredentialsProvider credentialsProvider) Constructs a new client to invoke service method on TestExecutionService using the specified qTest credentials provider and client configuration options.
TestDesignServiceClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
TestCase	addComment(CreateObjectCommentRequest createObjectCommentRequest) Creates testcase comment from the given request.
TestCase	approveTestCase(ApproveTestCaseRequest testCaseRequest) Approve testcase.
AutomationTestCase	createAutomationTestCase(CreateAutomationTestCaseRequest automationTestCaseRequest) Creates the automation test case from the given create automation test case request
TestCase	createTestCase(CreateTestCaseRequest testCaseRequest) Creates the test case from the given create test case request
TestStep	createTestStep(CreateTestStepRequest testStepRequest) Creates the test step from the given create test step request
void	deleteTestCase(DeleteTestCaseRequest testCaseRequest) Delete the test case from the given delete test-case request.
TestCase	getTestCase(GetTestCaseRequest testCaseRequest) Gets TestCase from the given test case request
java.util.List<Field>	getTestCaseFields(GetTestCaseFieldsRequest getTestCaseFieldsRequest) Returns the list of testcase custom fields.
TestStep	getTestStep(GetTestStepRequest testStepRequest) Gets TestStep from the given test step request
java.util.List<TestCase>	listTestCase(ListTestCaseRequest listTestCaseRequest) Lists all test case in the current project.
java.util.List<TestStep>	listTestStep(ListTestStepRequest testStepRequest) Gets list of TestStep from the given test step request
TestCase	moveTestCase(MoveTestCaseRequest testCaseRequest) Move test-case.
TestCase	updateTestCase(UpdateTestCaseRequest testCaseRequest) Update test-case.

Methods inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

init, invoke, shutdown, withEndpoint

Methods inherited from class org.qas.api.ApiWebServiceClient

addRequestHandler, createExecutionContext, createHttpAuthClient, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setTimeOffset, withConfiguration, withRequestHandler, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.qas.qtest.api.internal.QTestService

setEndpoint, shutdown

Constructor Detail

TestDesignServiceClient

public TestDesignServiceClient()

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.

TestDesignServiceClient

public TestDesignServiceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

TestDesignServiceClient

public TestDesignServiceClient(QTestCredentials credentials)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

TestDesignServiceClient

public TestDesignServiceClient(QTestCredentials credentials,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

TestDesignServiceClient

public TestDesignServiceClient(QTestCredentialsProvider credentialsProvider)

Constructs a new client to invoke service method on TestExecutionService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

TestDesignServiceClient

public TestDesignServiceClient(QTestCredentialsProvider credentialsProvider,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

Method Detail

getTestCase

public TestCase getTestCase(GetTestCaseRequest testCaseRequest)
                     throws AuthServiceException

Description copied from interface: TestDesignService

Gets TestCase from the given test case request

Specified by:

getTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given test case request

Returns:

the TestCase instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

listTestStep

public java.util.List<TestStep> listTestStep(ListTestStepRequest testStepRequest)
                                      throws AuthServiceException

Description copied from interface: TestDesignService

Gets list of TestStep from the given test step request

Specified by:

listTestStep in interface TestDesignService

Parameters:

testStepRequest - the given test step request

Returns:

the list of TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test step.

getTestStep

public TestStep getTestStep(GetTestStepRequest testStepRequest)
                     throws AuthServiceException

Description copied from interface: TestDesignService

Gets TestStep from the given test step request

Specified by:

getTestStep in interface TestDesignService

Parameters:

testStepRequest - the given test step request

Returns:

the TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

createTestCase

public TestCase createTestCase(CreateTestCaseRequest testCaseRequest)
                        throws AuthServiceException

Description copied from interface: TestDesignService

Creates the test case from the given create test case request

Specified by:

createTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given create test case request instance.

Returns:

the test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

createTestStep

public TestStep createTestStep(CreateTestStepRequest testStepRequest)
                        throws AuthServiceException

Description copied from interface: TestDesignService

Creates the test step from the given create test step request

Specified by:

createTestStep in interface TestDesignService

Parameters:

testStepRequest - the given create test step request instance.

Returns:

the test step instance.

Throws:

AuthServiceException - if an error occurs during creating test step instance.

listTestCase

public java.util.List<TestCase> listTestCase(ListTestCaseRequest listTestCaseRequest)
                                      throws AuthServiceException

Description copied from interface: TestDesignService

Lists all test case in the current project.

Specified by:

listTestCase in interface TestDesignService

Parameters:

listTestCaseRequest - the given list test case request object.

Returns:

the list of test case object.

Throws:

AuthServiceException - if an error occurs during listing all test case objects.

getTestCaseFields

public java.util.List<Field> getTestCaseFields(GetTestCaseFieldsRequest getTestCaseFieldsRequest)
                                        throws AuthServiceException

Description copied from interface: TestDesignService

Returns the list of testcase custom fields.

Specified by:

getTestCaseFields in interface TestDesignService

Parameters:

getTestCaseFieldsRequest - the given get testcase field request information

Returns:

the list of testcase custom fields

Throws:

AuthServiceException - if an error occurs during getting testcase fields.

addComment

public TestCase addComment(CreateObjectCommentRequest createObjectCommentRequest)
                    throws AuthServiceException

Description copied from interface: TestDesignService

Creates testcase comment from the given request.

Specified by:

addComment in interface TestDesignService

Parameters:

createObjectCommentRequest - the given create testcase comment request instance.

Returns:

the given TestCase instance.

Throws:

AuthServiceException - if an error occurs during adding comment.

createAutomationTestCase

public AutomationTestCase createAutomationTestCase(CreateAutomationTestCaseRequest automationTestCaseRequest)
                                            throws AuthServiceException

Description copied from interface: TestDesignService

Creates the automation test case from the given create automation test case request

Specified by:

createAutomationTestCase in interface TestDesignService

Parameters:

automationTestCaseRequest - the given create automation test case request instance.

Returns:

the automation test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

deleteTestCase

public void deleteTestCase(DeleteTestCaseRequest testCaseRequest)
                    throws AuthServiceException

Description copied from interface: TestDesignService

Delete the test case from the given delete test-case request.

Specified by:

deleteTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given test-case request.

Throws:

AuthServiceException - if an error occurs during deleting test-case.

updateTestCase

public TestCase updateTestCase(UpdateTestCaseRequest testCaseRequest)
                        throws AuthServiceException

Description copied from interface: TestDesignService

Update test-case.

Specified by:

updateTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given update test-case request.

Returns:

the test-case instance.

Throws:

AuthServiceException - if an error occurs during updating test-case.

moveTestCase

public TestCase moveTestCase(MoveTestCaseRequest testCaseRequest)
                      throws AuthServiceException

Description copied from interface: TestDesignService

Move test-case.

Specified by:

moveTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given move test-case request.

Returns:

the test-case instance.

Throws:

AuthServiceException - if an error occurs during moving test-case.

approveTestCase

public TestCase approveTestCase(ApproveTestCaseRequest testCaseRequest)
                         throws AuthServiceException

Description copied from interface: TestDesignService

Approve testcase.

Specified by:

approveTestCase in interface TestDesignService

Parameters:

testCaseRequest - the given approve testcase request.

Returns:

the TestCase instance.

Throws:

AuthServiceException - if an error occurs during approving testcase.