org.qas.qtest.api.services.requirement

Class RequirementServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.requirement.RequirementServiceClient

All Implemented Interfaces:

QTestService, RequirementService

Direct Known Subclasses:

RequirementServiceAsyncClient

public class RequirementServiceClient
extends QTestApiWebServiceClient<RequirementServiceClient>
implements RequirementService

RequirementServiceClient

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
RequirementServiceClient() Constructs a new client to invoke service method on RequirementService using the default qTest credentials provider and default client configuration options.
RequirementServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on RequirementService using the default qTest credentials provider and client configuration options.
RequirementServiceClient(QTestCredentials credentials) Constructs a new client to invoke service method on RequirementService using the specified qTest credentials.
RequirementServiceClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on RequirementService using the specified qTest credentials and client configuration options.
RequirementServiceClient(QTestCredentialsProvider credentialsProvider) Constructs a new client to invoke service method on RequirementService using the specified qTest credentials provider and client configuration options.
RequirementServiceClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on RequirementService using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
Requirement	addComment(CreateObjectCommentRequest createObjectCommentRequest) Create the requirement comment from the given request.
Requirement	createRequirement(CreateRequirementRequest createRequirementRequest) Creates the requirement from the given request.
java.util.List<Field>	getRequirementFields(GetRequirementFieldsRequest getRequirementFieldsRequest) Gets the requirement fields information.

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

RequirementServiceClient

public RequirementServiceClient()

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

RequirementServiceClient

public RequirementServiceClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

RequirementServiceClient

public RequirementServiceClient(QTestCredentials credentials)

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

Parameters:

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

RequirementServiceClient

public RequirementServiceClient(QTestCredentials credentials,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on RequirementService 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 RequirementService

RequirementServiceClient

public RequirementServiceClient(QTestCredentialsProvider credentialsProvider)

Constructs a new client to invoke service method on RequirementService 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.

RequirementServiceClient

public RequirementServiceClient(QTestCredentialsProvider credentialsProvider,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on RequirementService 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 RequirementService

Method Detail

getRequirementFields

public java.util.List<Field> getRequirementFields(GetRequirementFieldsRequest getRequirementFieldsRequest)
                                           throws AuthServiceException

Description copied from interface: RequirementService

Gets the requirement fields information.

Specified by:

getRequirementFields in interface RequirementService

Parameters:

getRequirementFieldsRequest - the given get requirement field request information.

Returns:

the list of requirement field.

Throws:

AuthServiceException - if an error occurs during getting the requirement fields.

createRequirement

public Requirement createRequirement(CreateRequirementRequest createRequirementRequest)
                              throws AuthServiceException

Description copied from interface: RequirementService

Creates the requirement from the given request.

Specified by:

createRequirement in interface RequirementService

Parameters:

createRequirementRequest - the given create requirement request instance that hold the requirement information.

Returns:

the requirement object.

Throws:

AuthServiceException - if an error occurs during creating requirement.

addComment

public Requirement addComment(CreateObjectCommentRequest createObjectCommentRequest)
                       throws AuthServiceException

Description copied from interface: RequirementService

Create the requirement comment from the given request.

Specified by:

addComment in interface RequirementService

Parameters:

createObjectCommentRequest - the given create requirement request instance that hold the requirement request information.

Returns:

the requirement information.

Throws:

AuthServiceException - if an error occurs during creating requirement comment.