|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.workflow.SimpleWorkflowManager com.atlassian.jira.workflow.OSWorkflowManager
public class OSWorkflowManager
Constructor Summary | |
---|---|
OSWorkflowManager(com.opensymphony.workflow.config.Configuration configuration,
DraftWorkflowStore draftWorkflowStore)
|
|
OSWorkflowManager(DraftWorkflowStore draftWorkflowStore)
|
Method Summary | |
---|---|
void |
copyAndDeleteDraftWorkflows(com.opensymphony.user.User user,
java.util.Set<JiraWorkflow> workflows)
Provided a set of workflows, this method will check, if the passed in workflows have any draft workflows linked to them. |
JiraWorkflow |
copyWorkflow(java.lang.String username,
java.lang.String clonedWorkflowName,
java.lang.String clonedWorkflowDescription,
JiraWorkflow workflowToClone)
Clones a workflow by creating a deep copy of the workflow provided. |
JiraWorkflow |
createDraftWorkflow(java.lang.String username,
java.lang.String parentWorkflowName)
This will create an draft workflow of the named active workflow. |
void |
createWorkflow(java.lang.String username,
JiraWorkflow workflow)
|
void |
createWorkflow(com.opensymphony.user.User creator,
JiraWorkflow workflow)
|
boolean |
deleteDraftWorkflow(java.lang.String parentWorkflowName)
Deletes all draft workflows (there should every be only one) for a given parent workflow. |
void |
deleteWorkflow(JiraWorkflow workflow)
|
java.util.Collection<JiraWorkflow> |
getActiveWorkflows()
Retrieve all currently active workflows. |
JiraWorkflow |
getDraftWorkflow(java.lang.String parentWorkflowName)
Retrieve a single draft workflow by name. |
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(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 |
getWorkflowClone(java.lang.String name)
This method returns a JiraWorkflow, that contains a WorkflowDescriptor
that is mutable. |
JiraWorkflow |
getWorkflowFromScheme(org.ofbiz.core.entity.GenericValue scheme,
java.lang.String issueTypeId)
Return the workflow in a particular scheme for a given issue type. |
protected java.lang.String |
getWorkflowName(java.lang.Long projectId,
java.lang.String issueType)
This method returns the (unique) name of the workflow which should be used for the provided projectId and issueType |
java.util.Collection<JiraWorkflow> |
getWorkflows()
Retrieve all of the workflows in the system |
protected WorkflowSchemeManager |
getWorkflowSchemeManager()
|
java.util.Collection<JiraWorkflow> |
getWorkflowsFromScheme(org.ofbiz.core.entity.GenericValue scheme)
Returns all workflows for a given scheme |
java.util.List<JiraWorkflow> |
getWorkflowsIncludingDrafts()
Retrieve all of the workflows in the system including drafts. |
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. |
void |
migrateIssueToWorkflow(org.ofbiz.core.entity.GenericValue issue,
JiraWorkflow newWorkflow,
org.ofbiz.core.entity.GenericValue newStatus)
Migrates given issue to new workflow and sets new status on it. |
void |
overwriteActiveWorkflow(java.lang.String username,
java.lang.String workflowName)
Saves the draft workflow into the active workflow. |
void |
saveWorkflowWithoutAudit(JiraWorkflow workflow)
This method will save the workflow and it will not affect the updatedDate and updatedAuthorName meta attributes of the workflow. |
protected void |
updateIssueStatusAndUpdatedDate(org.ofbiz.core.entity.GenericValue issue,
org.ofbiz.core.entity.GenericValue newStatus)
|
void |
updateWorkflow(java.lang.String username,
JiraWorkflow workflow)
Saves the given JiraWorkflow, which may be either a "live" or "draft" version. |
void |
updateWorkflowNameAndDescription(java.lang.String username,
JiraWorkflow currentWorkflow,
java.lang.String newName,
java.lang.String newDescription)
Used to change the name and description of an existing worfklow with the given name. |
boolean |
workflowExists(java.lang.String name)
|
Methods inherited from class com.atlassian.jira.workflow.SimpleWorkflowManager |
---|
createIssue, doWorkflowAction, getActionDescriptor, getConfiguration, getDefaultWorkflow, getPostFunctionsForWorkflow, getRemoteUser, getStepId, getStore, isEditable, makeWorkflow, migrateIssueToWorkflow, removeWorkflowEntries, resetConfiguration |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OSWorkflowManager(DraftWorkflowStore draftWorkflowStore)
public OSWorkflowManager(com.opensymphony.workflow.config.Configuration configuration, DraftWorkflowStore draftWorkflowStore)
Method Detail |
---|
public java.util.Collection<JiraWorkflow> getWorkflows()
getWorkflows
in interface WorkflowManager
getWorkflows
in class SimpleWorkflowManager
public java.util.List<JiraWorkflow> getWorkflowsIncludingDrafts()
WorkflowManager
getWorkflowsIncludingDrafts
in interface WorkflowManager
getWorkflowsIncludingDrafts
in class SimpleWorkflowManager
JiraWorkflow
objects.protected java.lang.String getWorkflowName(java.lang.Long projectId, java.lang.String issueType)
projectId
- issueType
-
public java.util.Collection<JiraWorkflow> getActiveWorkflows() throws WorkflowException
WorkflowManager
getActiveWorkflows
in interface WorkflowManager
getActiveWorkflows
in class SimpleWorkflowManager
WorkflowException
- RuntimeException wrapper for any errors.public boolean isActive(JiraWorkflow workflow) throws WorkflowException
WorkflowManager
isActive
in interface WorkflowManager
isActive
in class SimpleWorkflowManager
workflow
- the JiraWorkflow to check
WorkflowException
- RuntimeException wrapper for any errors.public boolean isSystemWorkflow(JiraWorkflow workflow)
WorkflowManager
isSystemWorkflow
in interface WorkflowManager
isSystemWorkflow
in class SimpleWorkflowManager
workflow
- the JiraWorkflow to check
public JiraWorkflow getWorkflow(java.lang.String name)
WorkflowManager
JiraWorkflow
contains a
descriptor that by default isn't mutable (see ImmutableWorkflowDescriptor
If you need to edit a workflow, please see WorkflowManager.getWorkflowClone(String)
.
getWorkflow
in interface WorkflowManager
getWorkflow
in class SimpleWorkflowManager
name
- The workflow name
JiraWorkflow
that wraps an ImmutableWorkflowDescriptor
or nullWorkflowManager.getWorkflowClone(String)
public JiraWorkflow getWorkflowClone(java.lang.String name)
WorkflowManager
WorkflowDescriptor
that is mutable. This method should be called, if you require to edit the workflow.
If you only need to view a workflow, please use WorkflowManager.getWorkflow(String)
as it will provide better
performance. Cloning a workflow is expensive, as it requires de-constructing and re-constructing the underlying
WorkflowDescriptor
from XML.
getWorkflowClone
in interface WorkflowManager
getWorkflowClone
in class SimpleWorkflowManager
name
- The workflow name
JiraWorkflow
or null if it doesn't exist.WorkflowManager.getWorkflow(String)
public JiraWorkflow getDraftWorkflow(java.lang.String parentWorkflowName) throws java.lang.IllegalArgumentException
WorkflowManager
getDraftWorkflow
in interface WorkflowManager
getDraftWorkflow
in class SimpleWorkflowManager
parentWorkflowName
- is the name of the Saved workflow which identifies then paritally edited draft workflow
to retrieve.
JiraDraftWorkflow
.
java.lang.IllegalArgumentException
- if no parentWorkflow with the name provided can be found.public JiraWorkflow createDraftWorkflow(java.lang.String username, java.lang.String parentWorkflowName)
WorkflowManager
IllegalStateException
in
this case.
createDraftWorkflow
in interface WorkflowManager
createDraftWorkflow
in class SimpleWorkflowManager
username
- identifies the user performing the action so that we can keep an audit trail of who has last
saved the workflow. Empty string for anonymous user. If null an IllegalArgumentException
will be thrownparentWorkflowName
- identifies the parent workflow that should be used as the template for creating the
draft workflow.
JiraDraftWorkflow
that represents a copy of the parent that can be edited without
overwriting the active workflow immediately.public boolean deleteDraftWorkflow(java.lang.String parentWorkflowName) throws java.lang.IllegalArgumentException
WorkflowManager
deleteDraftWorkflow
in interface WorkflowManager
deleteDraftWorkflow
in class SimpleWorkflowManager
parentWorkflowName
- The parentworkflow for which the draft workflow needs to be deleted.
java.lang.IllegalArgumentException
- if the parentWorkflowName is nullpublic boolean workflowExists(java.lang.String name) throws WorkflowException
workflowExists
in interface WorkflowManager
workflowExists
in class SimpleWorkflowManager
WorkflowException
public JiraWorkflow getWorkflow(Issue issue) throws WorkflowException
WorkflowManager
getWorkflow
in interface WorkflowManager
getWorkflow
in class SimpleWorkflowManager
issue
- the Issue
WorkflowException
- RuntimeException wrapper for any errors.public JiraWorkflow getWorkflow(java.lang.Long projectId, java.lang.String issueTypeId) throws WorkflowException
WorkflowManager
getWorkflow
in interface WorkflowManager
getWorkflow
in class SimpleWorkflowManager
projectId
- the ProjectissueTypeId
- the IssueType ID
WorkflowException
- RuntimeException wrapper for any errors.public JiraWorkflow getWorkflowFromScheme(org.ofbiz.core.entity.GenericValue scheme, java.lang.String issueTypeId)
WorkflowManager
getWorkflowFromScheme
in interface WorkflowManager
getWorkflowFromScheme
in class SimpleWorkflowManager
scheme
- the SchemeissueTypeId
- the IssueType ID
public java.util.Collection<JiraWorkflow> getWorkflowsFromScheme(org.ofbiz.core.entity.GenericValue scheme) throws WorkflowException
WorkflowManager
getWorkflowsFromScheme
in interface WorkflowManager
getWorkflowsFromScheme
in class SimpleWorkflowManager
scheme
- the Workflow Scheme
WorkflowException
- RuntimeException wrapper for any errors.public void copyAndDeleteDraftWorkflows(com.opensymphony.user.User user, java.util.Set<JiraWorkflow> workflows)
WorkflowManager
copyAndDeleteDraftWorkflows
in interface WorkflowManager
copyAndDeleteDraftWorkflows
in class SimpleWorkflowManager
user
- The user performing the operationworkflows
- A set of parent JiraWorkflow
spublic void createWorkflow(java.lang.String username, JiraWorkflow workflow) throws WorkflowException
createWorkflow
in interface WorkflowManager
createWorkflow
in class SimpleWorkflowManager
WorkflowException
public void createWorkflow(com.opensymphony.user.User creator, JiraWorkflow workflow) throws WorkflowException
createWorkflow
in interface WorkflowManager
createWorkflow
in class SimpleWorkflowManager
WorkflowException
public void saveWorkflowWithoutAudit(JiraWorkflow workflow) throws WorkflowException
WorkflowManager
WorkflowManager.updateWorkflow(String, JiraWorkflow)
saveWorkflowWithoutAudit
in interface WorkflowManager
saveWorkflowWithoutAudit
in class SimpleWorkflowManager
workflow
- the workflow to save.
WorkflowException
- RuntimeException wrapper for any errors.protected WorkflowSchemeManager getWorkflowSchemeManager()
public void deleteWorkflow(JiraWorkflow workflow) throws WorkflowException
deleteWorkflow
in interface WorkflowManager
deleteWorkflow
in class SimpleWorkflowManager
WorkflowException
public JiraWorkflow getWorkflow(org.ofbiz.core.entity.GenericValue issue) throws WorkflowException
WorkflowManager
getWorkflow
in interface WorkflowManager
getWorkflow
in class SimpleWorkflowManager
issue
- the Issue
WorkflowException
- RuntimeException wrapper for any errors.public void migrateIssueToWorkflow(org.ofbiz.core.entity.GenericValue issue, JiraWorkflow newWorkflow, org.ofbiz.core.entity.GenericValue newStatus) throws WorkflowException
WorkflowManager
migrateIssueToWorkflow
in interface WorkflowManager
migrateIssueToWorkflow
in class SimpleWorkflowManager
issue
- issue to migratenewWorkflow
- new workflownewStatus
- new status
WorkflowException
- if migration failspublic void overwriteActiveWorkflow(java.lang.String username, java.lang.String workflowName)
WorkflowManager
overwriteActiveWorkflow
in interface WorkflowManager
overwriteActiveWorkflow
in class SimpleWorkflowManager
username
- User will be added to the workflows Audit trailworkflowName
- The workflow to be overwrittenprotected void updateIssueStatusAndUpdatedDate(org.ofbiz.core.entity.GenericValue issue, org.ofbiz.core.entity.GenericValue newStatus)
public void updateWorkflow(java.lang.String username, JiraWorkflow workflow)
WorkflowManager
WorkflowManager.overwriteActiveWorkflow(String, String)
updateWorkflow
in interface WorkflowManager
updateWorkflow
in class SimpleWorkflowManager
username
- User making the request.workflow
- The JiraWorkflow to save.public JiraWorkflow copyWorkflow(java.lang.String username, java.lang.String clonedWorkflowName, java.lang.String clonedWorkflowDescription, JiraWorkflow workflowToClone)
WorkflowManager
copyWorkflow
in interface WorkflowManager
copyWorkflow
in class SimpleWorkflowManager
username
- The user performing the operationclonedWorkflowName
- The name to store the new workflow with.clonedWorkflowDescription
- The description to store with the cloned workflow. Can be null.workflowToClone
- The workflow to copy.
public void updateWorkflowNameAndDescription(java.lang.String username, JiraWorkflow currentWorkflow, java.lang.String newName, java.lang.String newDescription)
WorkflowManager
updateWorkflowNameAndDescription
in interface WorkflowManager
updateWorkflowNameAndDescription
in class SimpleWorkflowManager
username
- The user performing the operationcurrentWorkflow
- The workflow to update.newName
- The new name to save with the workflownewDescription
- The new descriptio to save with the workflow
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |