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(java.lang.String remoteUserName, java.util.Map fields)
void	createWorkflow(com.opensymphony.user.User creator, JiraWorkflow workflow)
void	deleteWorkflow(JiraWorkflow workflow)
void	doWorkflowAction(WorkflowProgressAware from)
com.opensymphony.workflow.loader.ActionDescriptor	getActionDescriptor(WorkflowProgressAware workflowProgressAware)
java.util.Collection	getActiveWorkflows() Retrieve all currently active workflows.
com.opensymphony.user.User	getRemoteUser(java.util.Map transientVars)
com.opensymphony.workflow.spi.WorkflowStore	getStore()
JiraWorkflow	getWorkflow(org.ofbiz.core.entity.GenericValue issue) Retrieve the workflow for a given issue.
JiraWorkflow	getWorkflow(java.lang.Long projectId, java.lang.String issueTypeId) Retrieve the workflow for a given project - issue type pair.
JiraWorkflow	getWorkflow(java.lang.String name) Retrieve a single workflow by name
JiraWorkflow	getWorkflowFromScheme(org.ofbiz.core.entity.GenericValue scheme, java.lang.String issueTypeId) Return the workflow in a particular scheme for a given issue type.
java.util.Collection	getWorkflows() Retrieve all of the workflows in the system
boolean	isActive(JiraWorkflow workflow) Determine whether or not a given workflow is active in the system.
boolean	isSystemWorkflow(JiraWorkflow workflow) Determine whether or not a given workflow is a system workflow.
com.opensymphony.workflow.Workflow	makeWorkflow(java.lang.String userName)
void	migrateIssueToWorkflow(org.ofbiz.core.entity.GenericValue issue, JiraWorkflow newWorkflow, org.ofbiz.core.entity.GenericValue status)
void	saveWorkflow(JiraWorkflow workflow)
boolean	workflowExists(java.lang.String name)

Method Detail

getWorkflows

java.util.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

java.util.Collection getActiveWorkflows()
                                        throws WorkflowException

Retrieve all currently active workflows.

Returns:

Collection of JiraWorkflow objects.

Throws:

WorkflowException

getWorkflow

JiraWorkflow getWorkflow(java.lang.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(java.lang.Long projectId,
                         java.lang.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,
                                   java.lang.String issueTypeId)
                                   throws WorkflowException

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

Throws:

WorkflowException

createIssue

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

Throws:

WorkflowException

doWorkflowAction

void doWorkflowAction(WorkflowProgressAware from)

getRemoteUser

com.opensymphony.user.User getRemoteUser(java.util.Map transientVars)
                                         throws com.opensymphony.user.EntityNotFoundException

Throws:

com.opensymphony.user.EntityNotFoundException

getStore

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

Throws:

com.opensymphony.workflow.StoreException

createWorkflow

void createWorkflow(com.opensymphony.user.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 java.lang.Exception

Throws:

java.lang.Exception

migrateIssueToWorkflow

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

Throws:

WorkflowException

makeWorkflow

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

workflowExists

boolean workflowExists(java.lang.String name)
                       throws WorkflowException

Throws:

WorkflowException