Package com.atlassian.jira.workflow

Class DefaultProjectWorkflowSchemeHelper

java.lang.Object

com.atlassian.jira.workflow.DefaultProjectWorkflowSchemeHelper

All Implemented Interfaces:

ProjectWorkflowSchemeHelper

public class DefaultProjectWorkflowSchemeHelper
extends Object
implements ProjectWorkflowSchemeHelper

Since:

v4.4

Constructor Summary

Constructors

Constructor	Description
DefaultProjectWorkflowSchemeHelper(ProjectService projectService, WorkflowSchemeManager workflowSchemeManager, JiraAuthenticationContext authenticationContext, ProjectManager projectManager)

Method Summary

Modifier and Type	Method	Description
List<Project>	getAllProjectsForScheme(Long schemeId)	Return a list of projects that use the workflow scheme with the passed query.
List<Project>	getAllProjectsForWorkflow(String workflowName)	Returns a list of the projects are currently using the passed workflow.
com.google.common.collect.Multimap<String,Project>	getAllProjectsForWorkflow(Set<String> workflows)	Return a map of active workflow names to the projects that use those workflows.
List<Project>	getProjectsForWorkflow(String workflowName)	Returns a list of the projects are currently using the passed workflow.
com.google.common.collect.Multimap<String,Project>	getProjectsForWorkflow(Set<String> workflows)	Return a map of active workflow names to the projects that use those workflows.
boolean	isWorkflowIsolated(String workflowName)	Checks whether given workflow is used by only one project.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultProjectWorkflowSchemeHelper

public DefaultProjectWorkflowSchemeHelper(ProjectService projectService,
 WorkflowSchemeManager workflowSchemeManager,
 JiraAuthenticationContext authenticationContext,
 ProjectManager projectManager)

Method Details

getAllProjectsForScheme

public List<Project> getAllProjectsForScheme(Long schemeId)

Description copied from interface: ProjectWorkflowSchemeHelper

Return a list of projects that use the workflow scheme with the passed query.

Specified by:

getAllProjectsForScheme in interface ProjectWorkflowSchemeHelper

Parameters:

schemeId - the scheme id query. Null can be passed to search for the magical default workflow scheme.

Returns:

a list of projects that use the workflow. The list is sorted by project name. The list is mutable and can be changed by the caller safely.

getProjectsForWorkflow

public List<Project> getProjectsForWorkflow(String workflowName)

Description copied from interface: ProjectWorkflowSchemeHelper

Returns a list of the projects are currently using the passed workflow. A workflow is only considered "active" if it is currently actually being used by a project. This means it is active if:

1. The workflow is mapped to an issue type in the project's scheme and the project has that issue type.
2. The workflow is a default for the project's scheme and there are some unmapped issue types.

Only projects that the passed user can change the configurtion for will be returned.

Specified by:

getProjectsForWorkflow in interface ProjectWorkflowSchemeHelper

Parameters:

workflowName - the name of the workflow the check.

Returns:

a list of active projects. The list is sorted by project name. The list is mutable and can be changed by the caller safely.

getAllProjectsForWorkflow

public List<Project> getAllProjectsForWorkflow(String workflowName)

Description copied from interface: ProjectWorkflowSchemeHelper

Returns a list of the projects are currently using the passed workflow. A workflow is only considered "active" if it is currently actually being used by a project. This means it is active if:

1. The workflow is mapped to an issue type in the project's scheme and the project has that issue type.
2. The workflow is a default for the project's scheme and there are some unmapped issue types.

Only projects that the passed user can change the configurtion for will be returned.

Specified by:

getAllProjectsForWorkflow in interface ProjectWorkflowSchemeHelper

Parameters:

workflowName - the name of the workflow the check.

Returns:

a list of active projects. The list is sorted by project name. The list is mutable and can be changed by the caller safely.

getProjectsForWorkflow

public com.google.common.collect.Multimap<String,Project> getProjectsForWorkflow(Set<String> workflows)

Description copied from interface: ProjectWorkflowSchemeHelper

Return a map of active workflow names to the projects that use those workflows. A workflow is only considered "active" if it is currently actually being used by a project. This means it is active if:

1. The workflow is mapped to an issue type in the project's scheme and the project has that issue type.
2. The workflow is a default for the project's scheme and there are some unmapped issue types.

Only projects that the passed user can change the configuration for will be returned.

Specified by:

getProjectsForWorkflow in interface ProjectWorkflowSchemeHelper

Parameters:

workflows - the workflows to query.

Returns:

a list of active projects. The projects are sorted by name. The map is mutable and can be changed by the caller.

getAllProjectsForWorkflow

public com.google.common.collect.Multimap<String,Project> getAllProjectsForWorkflow(Set<String> workflows)

Description copied from interface: ProjectWorkflowSchemeHelper

Return a map of active workflow names to the projects that use those workflows. A workflow is only considered "active" if it is currently actually being used by a project. This means it is active if:

1. The workflow is mapped to an issue type in the project's scheme and the project has that issue type.
2. The workflow is a default for the project's scheme and there are some unmapped issue types.

All projects will be returned, even projects which cannot be accessible by current user.

Specified by:

getAllProjectsForWorkflow in interface ProjectWorkflowSchemeHelper

Parameters:

workflows - the workflows to query.

Returns:

a list of active projects. The projects are sorted by name. The map is mutable and can be changed by the caller.

isWorkflowIsolated

public boolean isWorkflowIsolated(String workflowName)

Description copied from interface: ProjectWorkflowSchemeHelper

Checks whether given workflow is used by only one project.

Specified by:

isWorkflowIsolated in interface ProjectWorkflowSchemeHelper

Parameters:

workflowName - workflow name.

Returns:

true if given workflow is used only by one projects, false if it is used by zero or more than one projects.