org.squashtest.tm.service.project

Interface CustomGenericProjectManager

All Superinterfaces:

CustomGenericProjectFinder

All Known Subinterfaces:

GenericProjectManagerService

All Known Implementing Classes:

CustomGenericProjectManagerImpl

public interface CustomGenericProjectManager
extends CustomGenericProjectFinder

Author:

Gregory Fouquet

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewPermissionToProject(long userId, long projectId, String permission)
void	bindTestAutomationProject(long tmProjectId, org.squashtest.tm.domain.testautomation.TestAutomationProject taProject) Will bind the TM project to a TA project.
void	bindTestAutomationProjects(long tmProjectId, Collection<org.squashtest.tm.domain.testautomation.TestAutomationProject> taProjects)
void	bindTestAutomationServer(long tmProjectId, Long serverId) Will bind a TM project to a test automation server.
void	changeBugTracker(org.squashtest.tm.domain.project.GenericProject project, org.squashtest.csp.core.bugtracker.domain.BugTracker bugtracker) Change the Bugtracker the Project is associated-to.
void	changeBugTracker(long projectId, Long newBugtrackerId) Change the Bugtracker the Project is associated-to.
void	changeBugTrackerProjectName(long projectId, List<String> projectBugTrackerNames) Will change a bugtracker connexion parameter : the names of the bugtracker's projects it's associated to.
void	changeName(long projectId, String newName)
void	coerceTemplateIntoProject(long templateId)
void	deleteProject(long projectId)
Set<org.squashtest.tm.domain.execution.ExecutionStatus>	disabledExecutionStatuses(long projectId) Returns the list of disabled execution statuses given a project.
void	disableExecutionStatus(long projectId, org.squashtest.tm.domain.execution.ExecutionStatus executionStatus) Disables an execution status for a project
void	disablePluginForWorkspace(long projectId, org.squashtest.tm.api.workspace.WorkspaceType workspace, String pluginId) enables the given plugin for the given workspace of the given project
Set<org.squashtest.tm.domain.execution.ExecutionStatus>	enabledExecutionStatuses(long projectId) Returns the list of enabled execution statuses given a project.
void	enableExecutionStatus(long projectId, org.squashtest.tm.domain.execution.ExecutionStatus executionStatus) Enables an execution status for a project
void	enablePluginForWorkspace(long projectId, org.squashtest.tm.api.workspace.WorkspaceType workspace, String pluginId) enables the given plugin for the given workspace of the given project
org.squashtest.tm.domain.users.Party	findPartyById(long partyId)
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.project.GenericProject>>	findSortedProjects(org.squashtest.tm.core.foundation.collection.PagingAndMultiSorting pagingAndSorting, org.squashtest.tm.core.foundation.collection.Filtering filtering) Will find all Projects and Templates to which the user has management access to and return them ordered according to the given params.
Map<String,String>	getPluginConfiguration(long projectId, org.squashtest.tm.api.workspace.WorkspaceType workspace, String pluginId) Returns the configuration of a given plugin for a given project.
boolean	isExecutionStatusEnabledForProject(long projectId, org.squashtest.tm.domain.execution.ExecutionStatus executionStatus) Returns true if a given execution status is enabled for a given project, false otherwise
void	persist(org.squashtest.tm.domain.project.GenericProject project)
boolean	projectUsesExecutionStatus(long projectId, org.squashtest.tm.domain.execution.ExecutionStatus executionStatus)
void	removeBugTracker(long projectId) Will remove the association the Project has to it's Bugtracker.
void	removeProjectPermission(long userId, long projectId)
void	replaceExecutionStepStatus(long projectId, org.squashtest.tm.domain.execution.ExecutionStatus source, org.squashtest.tm.domain.execution.ExecutionStatus target) Replaces an execution status with another within a project
void	setPluginConfiguration(long projectId, org.squashtest.tm.api.workspace.WorkspaceType workspace, String pluginId, Map<String,String> configuration) Applies the given configuration to a plugin for a given project.
org.squashtest.tm.domain.project.GenericProject	synchronizeGenericProject(org.squashtest.tm.domain.project.GenericProject target, org.squashtest.tm.domain.project.GenericProject source, GenericProjectCopyParameter params)
void	unbindTestAutomationProject(long projectId, long taProjectId)

Methods inherited from interface org.squashtest.tm.service.project.CustomGenericProjectFinder

findAdministrableProjectById, findAllAvailableTaProjects, findAllAvailableTaProjectsWithCredentials, findAllPossiblePermission, findBoundTestAutomationProjects, findPartyPermissionsBeanByProject, findPartyPermissionsBeansByProject, findPartyWithoutPermissionByProject

Method Detail

findSortedProjects

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.project.GenericProject>> findSortedProjects(org.squashtest.tm.core.foundation.collection.PagingAndMultiSorting pagingAndSorting,
                                                                                                                                           org.squashtest.tm.core.foundation.collection.Filtering filtering)

Will find all Projects and Templates to which the user has management access to and return them ordered according to the given params.

Parameters:

pagingAndSorting - the PagingAndSorting that holds order and paging params

filter - the filter to apply on the result

Returns:

a PagedCollectionHolder containing all projects the user has management access to, ordered according to the given params.

persist

void persist(org.squashtest.tm.domain.project.GenericProject project)
             throws org.squashtest.tm.exception.NameAlreadyInUseException

Parameters:

project -

Throws:

org.squashtest.tm.exception.NameAlreadyInUseException

coerceTemplateIntoProject

void coerceTemplateIntoProject(long templateId)

Parameters:

templateId -

deleteProject

void deleteProject(long projectId)

addNewPermissionToProject

void addNewPermissionToProject(long userId,
                             long projectId,
                             String permission)

removeProjectPermission

void removeProjectPermission(long userId,
                           long projectId)

findPartyById

org.squashtest.tm.domain.users.Party findPartyById(long partyId)

bindTestAutomationServer

void bindTestAutomationServer(long tmProjectId,
                            Long serverId)

Will bind a TM project to a test automation server. Both are identified by their ID. The serverId may be null, in which case the TM project is bound to nothing. It will be then treated as a non automated project.

Parameters:

tmProjectId -

serverId -

bindTestAutomationProject

void bindTestAutomationProject(long tmProjectId,
                             org.squashtest.tm.domain.testautomation.TestAutomationProject taProject)

Will bind the TM project to a TA project. Will persist it if necessary.

Parameters:

TMprojectId -

TAproject -

bindTestAutomationProjects

void bindTestAutomationProjects(long tmProjectId,
                              Collection<org.squashtest.tm.domain.testautomation.TestAutomationProject> taProjects)

unbindTestAutomationProject

void unbindTestAutomationProject(long projectId,
                               long taProjectId)

changeBugTracker

void changeBugTracker(long projectId,
                    Long newBugtrackerId)

Change the Bugtracker the Project is associated-to.
If the Project had no Bugtracker, will add a new association.
If the Project had a already a Bugtracker, it will keep the project-Name information

Parameters:

projectId -

newBugtrackerId -

changeBugTracker

void changeBugTracker(org.squashtest.tm.domain.project.GenericProject project,
                    org.squashtest.csp.core.bugtracker.domain.BugTracker bugtracker)

Change the Bugtracker the Project is associated-to.
If the Project had no Bugtracker, will add a new association.
If the Project had a already a Bugtracker, it will keep the project-Name information

Parameters:

project - : the concerned GenericProject

bugtracker - : the bugtracker to bind the project to

removeBugTracker

void removeBugTracker(long projectId)

Will remove the association the Project has to it's Bugtracker.

Parameters:

projectId -

changeBugTrackerProjectName

void changeBugTrackerProjectName(long projectId,
                               List<String> projectBugTrackerNames)

Will change a bugtracker connexion parameter : the names of the bugtracker's projects it's associated to.

Parameters:

projectId - the concerned project

projectBugTrackerNames - the names of the bugtracker's projects, the Project is connected to

enablePluginForWorkspace

void enablePluginForWorkspace(long projectId,
                            org.squashtest.tm.api.workspace.WorkspaceType workspace,
                            String pluginId)

enables the given plugin for the given workspace of the given project

disablePluginForWorkspace

void disablePluginForWorkspace(long projectId,
                             org.squashtest.tm.api.workspace.WorkspaceType workspace,
                             String pluginId)

enables the given plugin for the given workspace of the given project

getPluginConfiguration

Map<String,String> getPluginConfiguration(long projectId,
                                        org.squashtest.tm.api.workspace.WorkspaceType workspace,
                                        String pluginId)

Returns the configuration of a given plugin for a given project. Returns an empty map if the plugin is not bound to this project.

setPluginConfiguration

void setPluginConfiguration(long projectId,
                          org.squashtest.tm.api.workspace.WorkspaceType workspace,
                          String pluginId,
                          Map<String,String> configuration)

Applies the given configuration to a plugin for a given project. If the plugin wasn't enabled for this project already, it will be during the process.

Parameters:

projectId -

workspace -

pluginId -

configuration -

enableExecutionStatus

void enableExecutionStatus(long projectId,
                         org.squashtest.tm.domain.execution.ExecutionStatus executionStatus)

Enables an execution status for a project

Parameters:

projectId -

executionStatus -

disableExecutionStatus

void disableExecutionStatus(long projectId,
                          org.squashtest.tm.domain.execution.ExecutionStatus executionStatus)

Disables an execution status for a project

Parameters:

projectId -

executionStatus -

enabledExecutionStatuses

Set<org.squashtest.tm.domain.execution.ExecutionStatus> enabledExecutionStatuses(long projectId)

Returns the list of enabled execution statuses given a project.

Parameters:

projectId -

Returns:

disabledExecutionStatuses

Set<org.squashtest.tm.domain.execution.ExecutionStatus> disabledExecutionStatuses(long projectId)

Returns the list of disabled execution statuses given a project.

Parameters:

projectId -

Returns:

replaceExecutionStepStatus

void replaceExecutionStepStatus(long projectId,
                              org.squashtest.tm.domain.execution.ExecutionStatus source,
                              org.squashtest.tm.domain.execution.ExecutionStatus target)

Replaces an execution status with another within a project

Parameters:

source -

target -

isExecutionStatusEnabledForProject

boolean isExecutionStatusEnabledForProject(long projectId,
                                         org.squashtest.tm.domain.execution.ExecutionStatus executionStatus)

Returns true if a given execution status is enabled for a given project, false otherwise

Parameters:

projectId -

executionStatus -

Returns:

projectUsesExecutionStatus

boolean projectUsesExecutionStatus(long projectId,
                                 org.squashtest.tm.domain.execution.ExecutionStatus executionStatus)

changeName

void changeName(long projectId,
              String newName)
                throws org.squashtest.tm.exception.NameAlreadyInUseException

Throws:

org.squashtest.tm.exception.NameAlreadyInUseException

synchronizeGenericProject

org.squashtest.tm.domain.project.GenericProject synchronizeGenericProject(org.squashtest.tm.domain.project.GenericProject target,
                                                                        org.squashtest.tm.domain.project.GenericProject source,
                                                                        GenericProjectCopyParameter params)