com.atlassian.jira.workflow
Interface WorkflowManager

All Known Implementing Classes:

OSWorkflowManager, SimpleWorkflowManager

public interface WorkflowManager

The WorkflowManager is used to interface with the workflow implementation

Method Summary

org.ofbiz.core.entity.GenericValue	createIssue(String remoteUserName, Map fields)
void	createWorkflow(User creator, JiraWorkflow workflow)
void	deleteWorkflow(JiraWorkflow workflow)
void	doWorkflowAction(WorkflowProgressAware from)
com.opensymphony.workflow.loader.ActionDescriptor	getActionDescriptor(WorkflowProgressAware workflowProgressAware)
Collection	getActiveWorkflows() Retrieve all currently active workflows.
JiraWorkflow	getDefaultWorkflow()
Map	getPostFunctionsForWorkflow(JiraWorkflow workflow)
User	getRemoteUser(Map transientVars)
String	getStepId(long actionDescriptorId, String workflowName) Gets the first stepId for the given action and workflow name.
com.opensymphony.workflow.spi.WorkflowStore	getStore()
JiraWorkflow	getWorkflow(org.ofbiz.core.entity.GenericValue issue) Retrieve the workflow for a given issue.
JiraWorkflow	getWorkflow(Issue issue) Retrieve the workflow for a given issue.
JiraWorkflow	getWorkflow(Long projectId, String issueTypeId) Retrieve the workflow for a given project - issue type pair.
JiraWorkflow	getWorkflow(String name) Retrieve a single workflow by name
JiraWorkflow	getWorkflowFromScheme(org.ofbiz.core.entity.GenericValue scheme, String issueTypeId) Return the workflow in a particular scheme for a given issue type.
Collection	getWorkflows() Retrieve all of the workflows in the system
Collection	getWorkflowsFromScheme(org.ofbiz.core.entity.GenericValue workflowScheme) Returns all workflows for a given scheme
boolean	isActive(JiraWorkflow workflow) Determine whether or not a given workflow is active in the system.
boolean	isEditable(Issue issue)
boolean	isSystemWorkflow(JiraWorkflow workflow) Determine whether or not a given workflow is a system workflow.
com.opensymphony.workflow.Workflow	makeWorkflow(String userName)
void	migrateIssueToWorkflow(org.ofbiz.core.entity.GenericValue issue, JiraWorkflow newWorkflow, org.ofbiz.core.entity.GenericValue status) Deprecated. Please use migrateIssueToWorkflow(com.atlassian.jira.issue.MutableIssue, JiraWorkflow, com.atlassian.jira.issue.status.Status). Since: 3.9.
void	migrateIssueToWorkflow(MutableIssue issue, JiraWorkflow newWorkflow, Status status) Migrates given issue to new workflow and sets new status on it.
void	removeWorkflowEntries(org.ofbiz.core.entity.GenericValue issue)
void	saveWorkflow(JiraWorkflow workflow)
boolean	workflowExists(String name)

Method Detail

getWorkflows

Collection getWorkflows()

Retrieve all of the workflows in the system

Returns:

A Collection of JiraWorkflow objects.

isActive

boolean isActive(JiraWorkflow workflow)
                 throws WorkflowException

Determine whether or not a given workflow is active in the system.

Active workflows are those currently assigned to schemes and associated with projects - they cannot be edited but can be used.

Throws:

WorkflowException

isSystemWorkflow

boolean isSystemWorkflow(JiraWorkflow workflow)
                         throws WorkflowException

Determine whether or not a given workflow is a system workflow.

Throws:

WorkflowException

getActiveWorkflows

Collection getActiveWorkflows()
                              throws WorkflowException

Retrieve all currently active workflows.

Returns:

Collection of JiraWorkflow objects.

Throws:

WorkflowException

getWorkflow

JiraWorkflow getWorkflow(String name)

Retrieve a single workflow by name

getWorkflow

JiraWorkflow getWorkflow(org.ofbiz.core.entity.GenericValue issue)
                         throws WorkflowException

Retrieve the workflow for a given issue.

Throws:

WorkflowException

getWorkflow

JiraWorkflow getWorkflow(Issue issue)
                         throws WorkflowException

Retrieve the workflow for a given issue.

Throws:

WorkflowException

getWorkflow

JiraWorkflow getWorkflow(Long projectId,
                         String issueTypeId)
                         throws WorkflowException

Retrieve the workflow for a given project - issue type pair.

Throws:

WorkflowException

getWorkflowFromScheme

JiraWorkflow getWorkflowFromScheme(org.ofbiz.core.entity.GenericValue scheme,
                                   String issueTypeId)
                                   throws WorkflowException

Return the workflow in a particular scheme for a given issue type.

Throws:

WorkflowException

getWorkflowsFromScheme

Collection getWorkflowsFromScheme(org.ofbiz.core.entity.GenericValue workflowScheme)
                                  throws WorkflowException

Returns all workflows for a given scheme

Parameters:

workflowScheme -

Returns:

Collection of workflow schemes, empty collection if none exists

Throws:

WorkflowException

getDefaultWorkflow

JiraWorkflow getDefaultWorkflow()
                                throws WorkflowException

Throws:

WorkflowException

createIssue

org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName,
                                               Map fields)
                                               throws WorkflowException

Throws:

WorkflowException

removeWorkflowEntries

void removeWorkflowEntries(org.ofbiz.core.entity.GenericValue issue)
                           throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

doWorkflowAction

void doWorkflowAction(WorkflowProgressAware from)

getRemoteUser

User getRemoteUser(Map transientVars)
                   throws EntityNotFoundException

Throws:

EntityNotFoundException

getStore

com.opensymphony.workflow.spi.WorkflowStore getStore()
                                                     throws com.opensymphony.workflow.StoreException

Throws:

com.opensymphony.workflow.StoreException

createWorkflow

void createWorkflow(User creator,
                    JiraWorkflow workflow)
                    throws WorkflowException

Throws:

WorkflowException

saveWorkflow

void saveWorkflow(JiraWorkflow workflow)
                  throws WorkflowException

Throws:

WorkflowException

deleteWorkflow

void deleteWorkflow(JiraWorkflow workflow)
                    throws WorkflowException

Throws:

WorkflowException

getActionDescriptor

com.opensymphony.workflow.loader.ActionDescriptor getActionDescriptor(WorkflowProgressAware workflowProgressAware)
                                                                      throws Exception

Throws:

Exception

migrateIssueToWorkflow

void migrateIssueToWorkflow(MutableIssue issue,
                            JiraWorkflow newWorkflow,
                            Status status)
                            throws WorkflowException

Migrates given issue to new workflow and sets new status on it.

Parameters:

issue - issue to migrate

newWorkflow - new workflow

status - new status

Throws:

WorkflowException - if migration fails

migrateIssueToWorkflow

void migrateIssueToWorkflow(org.ofbiz.core.entity.GenericValue issue,
                            JiraWorkflow newWorkflow,
                            org.ofbiz.core.entity.GenericValue status)
                            throws WorkflowException

Deprecated. Please use migrateIssueToWorkflow(com.atlassian.jira.issue.MutableIssue, JiraWorkflow, com.atlassian.jira.issue.status.Status). Since: 3.9.

Throws:

WorkflowException

makeWorkflow

com.opensymphony.workflow.Workflow makeWorkflow(String userName)

workflowExists

boolean workflowExists(String name)
                       throws WorkflowException

Throws:

WorkflowException

isEditable

boolean isEditable(Issue issue)

getPostFunctionsForWorkflow

Map getPostFunctionsForWorkflow(JiraWorkflow workflow)

getStepId

String getStepId(long actionDescriptorId,
                 String workflowName)

Gets the first stepId for the given action and workflow name.

Parameters:

actionDescriptorId - id of the ActionDescriptor

workflowName - name of the JiraWorkflow