com.atlassian.jira.workflow
Interface WorkflowSchemeManager

All Superinterfaces:

SchemeManager

All Known Implementing Classes:

DefaultWorkflowSchemeManager

public interface WorkflowSchemeManager
extends SchemeManager

Field Summary

Fields inherited from interface com.atlassian.jira.scheme.SchemeManager

PROJECT_ASSOCIATION

Method Summary

void	addWorkflowToScheme(org.ofbiz.core.entity.GenericValue scheme, String workflowName, String issueTypeId)
void	clearWorkflowCache()
Collection<String>	getActiveWorkflowNames()
String	getAssociationType()
org.ofbiz.core.entity.GenericValue	getDefaultEntity(org.ofbiz.core.entity.GenericValue scheme)
String	getEntityName()
List<org.ofbiz.core.entity.GenericValue>	getNonDefaultEntities(org.ofbiz.core.entity.GenericValue scheme)
String	getSchemeDesc()
String	getSchemeEntityName()
Collection<org.ofbiz.core.entity.GenericValue>	getSchemesForWorkflow(JiraWorkflow workflow)
Map<String,String>	getWorkflowMap(Project project) Returns a map representation of a workflow scheme for a passed project.
String	getWorkflowName(org.ofbiz.core.entity.GenericValue scheme, String issueType) Get the name of the workflow from the passed scheme associated with the passed issue type.
String	getWorkflowName(Project project, String issueType) Get the name of the workflow associated with the passed project and issue type.
org.ofbiz.core.entity.GenericValue	getWorkflowScheme(org.ofbiz.core.entity.GenericValue project)
void	updateSchemesForRenamedWorkflow(String oldWorkflowName, String newWorkflowName) Updates Workflow Schemes's such that schemes asscoiated to the workflow with name oldWorkflowName will be changed to newWorkflowName.

Methods inherited from interface com.atlassian.jira.scheme.SchemeManager

addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, createDefaultScheme, createScheme, createSchemeAndEntities, createSchemeEntity, deleteEntity, deleteScheme, getAssociatedSchemes, getDefaultScheme, getEntities, getEntities, getEntities, getEntities, getEntities, getEntities, getEntity, getGroups, getProjects, getProjects, getScheme, getScheme, getSchemeObject, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, hasSchemeAuthority, hasSchemeAuthority, removeEntities, removeEntities, removeSchemesFromProject, removeSchemesFromProject, schemeExists, updateScheme, updateScheme

Method Detail

getSchemeEntityName

String getSchemeEntityName()

getEntityName

String getEntityName()

getAssociationType

String getAssociationType()

getSchemeDesc

String getSchemeDesc()

getWorkflowScheme

org.ofbiz.core.entity.GenericValue getWorkflowScheme(org.ofbiz.core.entity.GenericValue project)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getDefaultEntity

org.ofbiz.core.entity.GenericValue getDefaultEntity(org.ofbiz.core.entity.GenericValue scheme)
                                                    throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getNonDefaultEntities

List<org.ofbiz.core.entity.GenericValue> getNonDefaultEntities(org.ofbiz.core.entity.GenericValue scheme)
                                                               throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getActiveWorkflowNames

Collection<String> getActiveWorkflowNames()
                                          throws org.ofbiz.core.entity.GenericEntityException,
                                                 WorkflowException

Returns:

A collection of all workflow names currently active (ie assigned to schemes & associated with projects).

Throws:

org.ofbiz.core.entity.GenericEntityException

WorkflowException

addWorkflowToScheme

void addWorkflowToScheme(org.ofbiz.core.entity.GenericValue scheme,
                         String workflowName,
                         String issueTypeId)
                         throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

updateSchemesForRenamedWorkflow

void updateSchemesForRenamedWorkflow(String oldWorkflowName,
                                     String newWorkflowName)

Updates Workflow Schemes's such that schemes asscoiated to the workflow with name oldWorkflowName will be changed to newWorkflowName.

Note: There is no validation performed by this method to determine if the provided oldWorkflowName or newWorkflowName are valid workflow names or if the workflow is active/inactive. These validations must be done by the caller.

Parameters:

oldWorkflowName - name of the workflow to re-assign all its associated schemes from

newWorkflowName - name of the workflow to assign all the schemes associated to targetWorkflow

getSchemesForWorkflow

Collection<org.ofbiz.core.entity.GenericValue> getSchemesForWorkflow(JiraWorkflow workflow)

clearWorkflowCache

void clearWorkflowCache()

getWorkflowMap

Map<String,String> getWorkflowMap(Project project)

Returns a map representation of a workflow scheme for a passed project. The returned map stores {issuetype -> workflowName}. A null issuetype points out the default workflow for the scheme.

Parameters:

project - the project whose scheme should be returned.

Returns:

the map representation of a workflow scheme. Each key represents an issuetype which its associated value the name of the workflow assigned to that issue type. A null issuetype points out the default workflow for that scheme.

getWorkflowName

String getWorkflowName(Project project,
                       String issueType)

Get the name of the workflow associated with the passed project and issue type.

Parameters:

project - the project used in the search.

issueType - the issue type used in the search.

Returns:

the name of the workflow associated with the passed project and issue type.

getWorkflowName

String getWorkflowName(org.ofbiz.core.entity.GenericValue scheme,
                       String issueType)

Get the name of the workflow from the passed scheme associated with the passed issue type.

Parameters:

scheme - the scheme to search.

issueType - the issue type used in the search.

Returns:

the name of the workflow associated with the scheme and issue type.