org.qas.qtest.api.services.project

Interface ProjectService

All Superinterfaces:

QTestService

All Known Subinterfaces:

ProjectServiceAsync

All Known Implementing Classes:

ProjectServiceAsyncClient, ProjectServiceClient

public interface ProjectService
extends QTestService

ProjectService

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Field	createCustomField(CreateCustomFieldRequest createCustomFieldRequest) Creates custom field from the given CreateCustomFieldRequest instance.
Module	createModule(CreateModuleRequest request) Creates module from the given create module request object instance.
Project	createProject(CreateProjectRequest request) 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 request) 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 request) 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 interface org.qas.qtest.api.internal.QTestService

setEndpoint, shutdown

Method Detail

listProject

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

Lists all projects in user space.

Parameters:

request - the given request to listing all projects.

Returns:

all projects in user space.

Throws:

AuthServiceException - if an error occurs during listing all projects.

createProject

Project createProject(CreateProjectRequest request)
               throws AuthServiceException

Creates project from the given create project request

Parameters:

request - the given create project request to set.

Returns:

the created project instance.

Throws:

AuthServiceException - if an error occurs during creating project.

getProject

Project getProject(GetProjectRequest request)
            throws AuthServiceException

Gets the project from the given get project request.

Parameters:

request - the given get project request.

Returns:

the project information.

Throws:

AuthServiceException - if an error occurs during getting project.

updateModule

Module updateModule(UpdateModuleRequest moduleRequest)
             throws AuthServiceException

Update modules request.

Parameters:

moduleRequest - the given update module request.

Returns:

the current module.

Throws:

AuthServiceException - if an error occurs during updating module.

moveModule

Module moveModule(MoveModuleRequest moduleRequest)
           throws AuthServiceException

Move modules request.

Parameters:

moduleRequest - the given module request.

Returns:

the current module.

Throws:

AuthServiceException - if an error occurs during moving module.

createModule

Module createModule(CreateModuleRequest request)
             throws AuthServiceException

Creates module from the given create module request object instance.

Parameters:

request - the given create module request to set.

Returns:

the create module instance.

Throws:

AuthServiceException - if an error occurs during creating module.

getModule

Module getModule(GetModuleRequest getModuleRequest)
          throws AuthServiceException

Gets module from the given get module request object instance.

Parameters:

getModuleRequest - the given get module request

Returns:

the module instance.

Throws:

AuthServiceException - if an error occurs during getting module.

listModule

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

Lists modules from the given get module request object instance.

Parameters:

listModuleRequest - the given list module request

Returns:

the list of modules.

Throws:

AuthServiceException - if an error occurs during listing modules.

listRelease

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

List all release of project

Parameters:

listReleaseRequest - request to list release

Returns:

a list of release

Throws:

AuthServiceException - if an error occurs during listing release

searchModule

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

Search modules.

Parameters:

searchModuleRequest - the given search module request.

Returns:

the list of modules.

Throws:

AuthServiceException - if an error occurs during searching modules.

deleteModule

void deleteModule(DeleteModuleRequest moduleRequest)
           throws AuthServiceException

Delete module.

Parameters:

moduleRequest - the given delete module request.

Throws:

AuthServiceException - if an error occurs during deleting module.

createCustomField

Field createCustomField(CreateCustomFieldRequest createCustomFieldRequest)
                 throws AuthServiceException

Creates custom field from the given CreateCustomFieldRequest instance.

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

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

Update is_active of custom field

Parameters:

updateCustomFieldRequest -

Returns:

Throws:

AuthServiceException

updateSystemField

Field updateSystemField(UpdateSystemFieldRequest updateSystemFieldRequest)
                 throws AuthServiceException

Updates system field from the given UpdateSystemFieldRequest instance.

Parameters:

updateSystemFieldRequest - the given UpdateSystemFieldRequest instance to set.

Throws:

AuthServiceException - if an error occurs during

getUserPermissions

UserPermissions getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest)
                            throws AuthServiceException

Gets user permission.

Parameters:

getUserPermissionsRequest - the given GetUserPermissionsRequest instance.

Returns:

the UserPermissions object.

Throws:

AuthServiceException - if an error occurs during getting user permissions.

listUserPermissions

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

List all user permissions in all active projects.

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.

getFields

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

Gets all fields from the given field request.

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.