com.atlassian.jira.workflow
Interface WorkflowManager

All Known Implementing Classes:
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.
 Map getPostFunctionsForWorkflow(JiraWorkflow workflow)
           
 User getRemoteUser(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(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)
           
 void removeWorkflowEntries(org.ofbiz.core.entity.GenericValue issue)
           
 void saveWorkflow(JiraWorkflow workflow)
           
 boolean workflowExists(String name)
           
 

Method Detail

getWorkflows

public Collection getWorkflows()
Retrieve all of the workflows in the system

Returns:
A collection of JiraWorkflow objects.

isActive

public 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

public boolean isSystemWorkflow(JiraWorkflow workflow)
                         throws WorkflowException
Determine whether or not a given workflow is a system workflow.

Throws:
WorkflowException

getActiveWorkflows

public Collection getActiveWorkflows()
                              throws WorkflowException
Retrieve all currently active workflows.

Returns:
Collection of JiraWorkflow objects.
Throws:
WorkflowException

getWorkflow

public JiraWorkflow getWorkflow(String name)
Retrieve a single workflow by name


getWorkflow

public JiraWorkflow getWorkflow(org.ofbiz.core.entity.GenericValue issue)
                         throws WorkflowException
Retrieve the workflow for a given issue.

Throws:
WorkflowException

getWorkflow

public JiraWorkflow getWorkflow(Issue issue)
                         throws WorkflowException
Retrieve the workflow for a given issue.

Throws:
WorkflowException

getWorkflow

public JiraWorkflow getWorkflow(Long projectId,
                                String issueTypeId)
                         throws WorkflowException
Retrieve the workflow for a given project - issue type pair.

Throws:
WorkflowException

getWorkflowFromScheme

public 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

public 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

createIssue

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

removeWorkflowEntries

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

doWorkflowAction

public void doWorkflowAction(WorkflowProgressAware from)

getRemoteUser

public User getRemoteUser(Map transientVars)
                   throws EntityNotFoundException
Throws:
EntityNotFoundException

getStore

public com.opensymphony.workflow.spi.WorkflowStore getStore()
                                                     throws com.opensymphony.workflow.StoreException
Throws:
com.opensymphony.workflow.StoreException

createWorkflow

public void createWorkflow(User creator,
                           JiraWorkflow workflow)
                    throws WorkflowException
Throws:
WorkflowException

saveWorkflow

public void saveWorkflow(JiraWorkflow workflow)
                  throws WorkflowException
Throws:
WorkflowException

deleteWorkflow

public void deleteWorkflow(JiraWorkflow workflow)
                    throws WorkflowException
Throws:
WorkflowException

getActionDescriptor

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

migrateIssueToWorkflow

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

makeWorkflow

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

workflowExists

public boolean workflowExists(String name)
                       throws WorkflowException
Throws:
WorkflowException

isEditable

public boolean isEditable(Issue issue)

getPostFunctionsForWorkflow

public Map getPostFunctionsForWorkflow(JiraWorkflow workflow)


Copyright © 2002-2006 Atlassian. All Rights Reserved.