org.qas.qtest.api.services.project

Class ProjectServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.project.ProjectServiceClient

All Implemented Interfaces:

QTestService, ProjectService

Direct Known Subclasses:

ProjectServiceAsyncClient

public class ProjectServiceClient
extends QTestApiWebServiceClient<ProjectServiceClient>
implements ProjectService

ProjectServiceClient

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

Method Summary

Modifier and Type	Method and Description
Field	createCustomField(CreateCustomFieldRequest createCustomFieldRequest) Creates custom field from the given CreateCustomFieldRequest instance.
Module	createModule(CreateModuleRequest createModuleRequest) Creates module from the given create module request object instance.
Project	createProject(CreateProjectRequest createProjectRequest) Creates project from the given create project request
void	deleteModule(DeleteModuleRequest moduleRequest) Delete module.
java.util.List<Field>	getFields(GetFieldsRequest getFieldsRequest) Gets all fields from the given field request.
Module	getModule(GetModuleRequest getModuleRequest) Gets module from the given get module request object instance.
Project	getProject(GetProjectRequest getProjectRequest) Gets the project from the given get project request.
UserPermissions	getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest) Gets user permission.
java.util.List<Module>	listModule(ListModuleRequest listModuleRequest) Lists modules from the given get module request object instance.
java.util.List<Project>	listProject(ListProjectRequest listProjectRequest) Lists all projects in user space.
java.util.List<Release>	listRelease(ListReleaseRequest listReleaseRequest) List all release of project
java.util.List<UserPermissions>	listUserPermissions(ListUserPermissionsRequest listUserPermissionsRequest) List all user permissions in all active projects.
Module	moveModule(MoveModuleRequest moduleRequest) Move modules request.
java.util.List<Module>	searchModule(SearchModuleRequest searchModuleRequest) Search modules.
java.util.List<Field>	updateCustomField(UpdateCustomFieldRequest updateCustomFieldRequest) Update is_active of custom field
Module	updateModule(UpdateModuleRequest moduleRequest) Update modules request.
Field	updateSystemField(UpdateSystemFieldRequest updateSystemFieldRequest) Updates system field from the given UpdateSystemFieldRequest instance.

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

ProjectServiceClient

public ProjectServiceClient()

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

ProjectServiceClient

public ProjectServiceClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

ProjectServiceClient

public ProjectServiceClient(QTestCredentials credentials)

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

Parameters:

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

ProjectServiceClient

public ProjectServiceClient(QTestCredentials credentials,
                            ClientConfiguration clientConfiguration)

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

ProjectServiceClient

public ProjectServiceClient(QTestCredentialsProvider credentialsProvider)

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

ProjectServiceClient

public ProjectServiceClient(QTestCredentialsProvider credentialsProvider,
                            ClientConfiguration clientConfiguration)

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

Method Detail

listProject

public java.util.List<Project> listProject(ListProjectRequest listProjectRequest)
                                    throws AuthServiceException

Description copied from interface: ProjectService

Lists all projects in user space.

Specified by:

listProject in interface ProjectService

Parameters:

listProjectRequest - the given request to listing all projects.

Returns:

all projects in user space.

Throws:

AuthServiceException - if an error occurs during listing all projects.

createProject

public Project createProject(CreateProjectRequest createProjectRequest)
                      throws AuthServiceException

Description copied from interface: ProjectService

Creates project from the given create project request

Specified by:

createProject in interface ProjectService

Parameters:

createProjectRequest - the given create project request to set.

Returns:

the created project instance.

Throws:

AuthServiceException - if an error occurs during creating project.

getProject

public Project getProject(GetProjectRequest getProjectRequest)
                   throws AuthServiceException

Description copied from interface: ProjectService

Gets the project from the given get project request.

Specified by:

getProject in interface ProjectService

Parameters:

getProjectRequest - the given get project request.

Returns:

the project information.

Throws:

AuthServiceException - if an error occurs during getting project.

updateModule

public Module updateModule(UpdateModuleRequest moduleRequest)
                    throws AuthServiceException

Description copied from interface: ProjectService

Update modules request.

Specified by:

updateModule in interface ProjectService

Parameters:

moduleRequest - the given update module request.

Returns:

the current module.

Throws:

AuthServiceException - if an error occurs during updating module.

moveModule

public Module moveModule(MoveModuleRequest moduleRequest)
                  throws AuthServiceException

Description copied from interface: ProjectService

Move modules request.

Specified by:

moveModule in interface ProjectService

Parameters:

moduleRequest - the given module request.

Returns:

the current module.

Throws:

AuthServiceException - if an error occurs during moving module.

createModule

public Module createModule(CreateModuleRequest createModuleRequest)
                    throws AuthServiceException

Description copied from interface: ProjectService

Creates module from the given create module request object instance.

Specified by:

createModule in interface ProjectService

Parameters:

createModuleRequest - the given create module request to set.

Returns:

the create module instance.

Throws:

AuthServiceException - if an error occurs during creating module.

getModule

public Module getModule(GetModuleRequest getModuleRequest)
                 throws AuthServiceException

Description copied from interface: ProjectService

Gets module from the given get module request object instance.

Specified by:

getModule in interface ProjectService

Parameters:

getModuleRequest - the given get module request

Returns:

the module instance.

Throws:

AuthServiceException - if an error occurs during getting module.

listModule

public java.util.List<Module> listModule(ListModuleRequest listModuleRequest)
                                  throws AuthServiceException

Description copied from interface: ProjectService

Lists modules from the given get module request object instance.

Specified by:

listModule in interface ProjectService

Parameters:

listModuleRequest - the given list module request

Returns:

the list of modules.

Throws:

AuthServiceException - if an error occurs during listing modules.

listRelease

public java.util.List<Release> listRelease(ListReleaseRequest listReleaseRequest)
                                    throws AuthServiceException

Description copied from interface: ProjectService

List all release of project

Specified by:

listRelease in interface ProjectService

Parameters:

listReleaseRequest - request to list release

Returns:

a list of release

Throws:

AuthServiceException - if an error occurs during listing release

searchModule

public java.util.List<Module> searchModule(SearchModuleRequest searchModuleRequest)
                                    throws AuthServiceException

Description copied from interface: ProjectService

Search modules.

Specified by:

searchModule in interface ProjectService

Parameters:

searchModuleRequest - the given search module request.

Returns:

the list of modules.

Throws:

AuthServiceException - if an error occurs during searching modules.

deleteModule

public void deleteModule(DeleteModuleRequest moduleRequest)
                  throws AuthServiceException

Description copied from interface: ProjectService

Delete module.

Specified by:

deleteModule in interface ProjectService

Parameters:

moduleRequest - the given delete module request.

Throws:

AuthServiceException - if an error occurs during deleting module.

createCustomField

public Field createCustomField(CreateCustomFieldRequest createCustomFieldRequest)
                        throws AuthServiceException

Description copied from interface: ProjectService

Creates custom field from the given CreateCustomFieldRequest instance.

Specified by:

createCustomField in interface ProjectService

Parameters:

createCustomFieldRequest - the given CreateCustomFieldRequest instance to set.

Returns:

the Field instance.

Throws:

AuthServiceException - if an error occurs during creating custom field to project.

updateCustomField

public java.util.List<Field> updateCustomField(UpdateCustomFieldRequest updateCustomFieldRequest)
                                        throws AuthServiceException

Description copied from interface: ProjectService

Update is_active of custom field

Specified by:

updateCustomField in interface ProjectService

Returns:

Throws:

AuthServiceException

updateSystemField

public Field updateSystemField(UpdateSystemFieldRequest updateSystemFieldRequest)
                        throws AuthServiceException

Description copied from interface: ProjectService

Updates system field from the given UpdateSystemFieldRequest instance.

Specified by:

updateSystemField in interface ProjectService

Parameters:

updateSystemFieldRequest - the given UpdateSystemFieldRequest instance to set.

Throws:

AuthServiceException - if an error occurs during

getFields

public java.util.List<Field> getFields(GetFieldsRequest getFieldsRequest)
                                throws AuthServiceException

Description copied from interface: ProjectService

Gets all fields from the given field request.

Specified by:

getFields in interface ProjectService

Parameters:

getFieldsRequest - the given GET fields request to get all fields.

Returns:

the list of fields.

Throws:

AuthServiceException - if an error occurs during getting fields.

getUserPermissions

public UserPermissions getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest)
                                   throws AuthServiceException

Description copied from interface: ProjectService

Gets user permission.

Specified by:

getUserPermissions in interface ProjectService

Parameters:

getUserPermissionsRequest - the given GetUserPermissionsRequest instance.

Returns:

the UserPermissions object.

Throws:

AuthServiceException - if an error occurs during getting user permissions.

listUserPermissions

public java.util.List<UserPermissions> listUserPermissions(ListUserPermissionsRequest listUserPermissionsRequest)
                                                    throws AuthServiceException

Description copied from interface: ProjectService

List all user permissions in all active projects.

Specified by:

listUserPermissions in interface ProjectService

Parameters:

listUserPermissionsRequest - the given ListUserPermissionsRequest instance.

Returns:

the list of user permission objects.

Throws:

AuthServiceException - if an error occurs during listing all user permissions on active projects.