public abstract class AbstractJiraWorkflow extends Object implements JiraWorkflow
Modifier and Type | Field and Description |
---|---|
protected WorkflowManager |
workflowManager |
ACTION_ORIGIN_STEP_ID, ACTION_SCREEN_ATTRIBUTE, ACTION_TYPE_ALL, ACTION_TYPE_COMMON, ACTION_TYPE_GLOBAL, ACTION_TYPE_INITIAL, ACTION_TYPE_ORDINARY, DEFAULT_WORKFLOW_NAME, DRAFT, JIRA_META_ATTRIBUTE_ALLOWED_LIST, JIRA_META_ATTRIBUTE_EDIT_ALLOWED, JIRA_META_ATTRIBUTE_EXCLUDE_RESOLUTION, JIRA_META_ATTRIBUTE_I18N, JIRA_META_ATTRIBUTE_I18N_SUBMIT, JIRA_META_ATTRIBUTE_INCLUDE_RESOLUTION, JIRA_META_ATTRIBUTE_KEY_PREFIX, JIRA_META_ATTRIBUTE_PERMISSION, JIRA_META_UPDATE_AUTHOR_KEY, JIRA_META_UPDATE_AUTHOR_NAME, JIRA_META_UPDATED_DATE, LIVE, STEP_STATUS_KEY, WORKFLOW_DESCRIPTION_ATTRIBUTE, WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE
Modifier | Constructor and Description |
---|---|
protected |
AbstractJiraWorkflow(WorkflowManager workflowManager,
com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(JiraWorkflow o) |
boolean |
equals(Object o) |
Collection<com.opensymphony.workflow.loader.ActionDescriptor> |
getActionsByName(String name)
Get all actions in this workflow, global, common and from steps, whose name matched
name . |
Collection<com.opensymphony.workflow.loader.ActionDescriptor> |
getActionsForScreen(FieldScreen fieldScreen) |
Collection<com.opensymphony.workflow.loader.ActionDescriptor> |
getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get all the actions which have a particular step as their unconditional result.
|
String |
getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) |
Collection<com.opensymphony.workflow.loader.ActionDescriptor> |
getAllActions()
Get all the actions in this workflow, global, common and from steps.
|
String |
getDescription() |
com.opensymphony.workflow.loader.WorkflowDescriptor |
getDescriptor() |
String |
getDisplayName() |
Status |
getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get the Status associated with the given StepDescriptor.
|
List<org.ofbiz.core.entity.GenericValue> |
getLinkedStatuses()
Returns all statuses for this workflow
|
String |
getLinkedStatusId(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get the id of the
Status associated with the given StepDescriptor |
Set<String> |
getLinkedStatusIds()
Returns all status ids for this workflow
|
Status |
getLinkedStatusObject(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get the Status associated with the given StepDescriptor.
|
List<Status> |
getLinkedStatusObjects()
Returns all statuses for this workflow
|
com.opensymphony.workflow.loader.StepDescriptor |
getLinkedStep(org.ofbiz.core.entity.GenericValue status)
Get the StepDescriptor linked to the given status for this workflow.
|
com.opensymphony.workflow.loader.StepDescriptor |
getLinkedStep(Status status)
Get the StepDescriptor linked to the given status for this workflow.
|
String |
getMode()
Returns either
JiraWorkflow.DRAFT or JiraWorkflow.LIVE depending on the workflow implementation. |
abstract String |
getName() |
int |
getNextActionId()
Get the next available action id
|
Collection<com.opensymphony.workflow.loader.FunctionDescriptor> |
getPostFunctionsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Returns all post-functions of the transition, including the ones on all conditional results,
unconditional results and 'global' (non-result) postfunctions.
|
Collection |
getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Returns a collection of all step descriptors that reference the given common action.
|
Collection |
getStepsWithAction(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor) |
ApplicationUser |
getUpdateAuthor()
Returns the most recent author
|
String |
getUpdateAuthorName()
Returns the most recent authors username.
|
Date |
getUpdatedDate()
Returns the date of the most recent update to this workflow.
|
boolean |
hasDraftWorkflow()
Determines if this workflow has a draft edit copy.
|
int |
hashCode() |
boolean |
isActive()
Determine whether this workflow object is currently active.
|
boolean |
isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) |
boolean |
isDefault()
Determines if the workflow is the default JIRA workflow
|
boolean |
isEditable()
Determines if the workflow can be modifed within JIRA.
|
boolean |
isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) |
boolean |
isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) |
boolean |
isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) |
boolean |
isSystemWorkflow()
Determines if the workflow is loaded from XML or the database
|
boolean |
removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Remove a step from the workflow.
|
void |
reset() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
isDraftWorkflow
protected final WorkflowManager workflowManager
protected AbstractJiraWorkflow(WorkflowManager workflowManager, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)
public abstract String getName()
getName
in interface JiraWorkflow
public String getDescription()
getDescription
in interface JiraWorkflow
public String getDisplayName()
getDisplayName
in interface JiraWorkflow
public com.opensymphony.workflow.loader.WorkflowDescriptor getDescriptor()
getDescriptor
in interface JiraWorkflow
public Collection<com.opensymphony.workflow.loader.ActionDescriptor> getAllActions()
JiraWorkflow
getAllActions
in interface JiraWorkflow
ActionDescriptor
s.public Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsByName(String name)
JiraWorkflow
name
.getActionsByName
in interface JiraWorkflow
name
- of the action to match. This is case-insensitive.ActionDescriptor
whose name matched the given name
.public int getNextActionId()
JiraWorkflow
getNextActionId
in interface JiraWorkflow
public Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
JiraWorkflow
getActionsWithResult
in interface JiraWorkflow
public Collection getStepsWithAction(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
public boolean removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
JiraWorkflow
This method will also remove all actions with this step ID as their unconditional result.
removeStep
in interface JiraWorkflow
true
if the remove was successfulpublic com.opensymphony.workflow.loader.StepDescriptor getLinkedStep(org.ofbiz.core.entity.GenericValue status)
JiraWorkflow
getLinkedStep
in interface JiraWorkflow
status
- the Statuspublic com.opensymphony.workflow.loader.StepDescriptor getLinkedStep(Status status)
JiraWorkflow
getLinkedStep
in interface JiraWorkflow
status
- the Statuspublic Status getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
JiraWorkflow
getLinkedStatus
in interface JiraWorkflow
stepDescriptor
- the StepDescriptorpublic Status getLinkedStatusObject(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
JiraWorkflow
getLinkedStatusObject
in interface JiraWorkflow
stepDescriptor
- the StepDescriptorpublic String getLinkedStatusId(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
JiraWorkflow
Status
associated with the given StepDescriptor
getLinkedStatusId
in interface JiraWorkflow
stepDescriptor
- the StepDescriptorpublic List<org.ofbiz.core.entity.GenericValue> getLinkedStatuses()
JiraWorkflow
getLinkedStatuses
in interface JiraWorkflow
List
of GenericValue
public List<Status> getLinkedStatusObjects()
JiraWorkflow
getLinkedStatusObjects
in interface JiraWorkflow
List
of Status
objectspublic Set<String> getLinkedStatusIds()
JiraWorkflow
getLinkedStatusIds
in interface JiraWorkflow
Set
of String
status id'spublic Collection getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
JiraWorkflow
getStepsForTransition
in interface JiraWorkflow
public Collection<com.opensymphony.workflow.loader.FunctionDescriptor> getPostFunctionsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
JiraWorkflow
getPostFunctionsForTransition
in interface JiraWorkflow
public boolean isActive() throws WorkflowException
JiraWorkflow
isActive
in interface JiraWorkflow
true
if this workflow object is active.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.public boolean isSystemWorkflow() throws WorkflowException
JiraWorkflow
isSystemWorkflow
in interface JiraWorkflow
true
if this workflow object is the uneditable system workflow.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.public boolean isEditable() throws WorkflowException
JiraWorkflow
System workflows are never editable. The "published" version of an active workflow is not editable, but the draft version is. Inactive workflows are editable.
isEditable
in interface JiraWorkflow
true
if this workflow is editable.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.public boolean isDefault()
JiraWorkflow
isDefault
in interface JiraWorkflow
true
if this is the workflow is the default JIRA workflow.public boolean isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
isInitialAction
in interface JiraWorkflow
public boolean isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
isCommonAction
in interface JiraWorkflow
public boolean isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
isGlobalAction
in interface JiraWorkflow
public boolean isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
isOrdinaryAction
in interface JiraWorkflow
public String getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
getActionType
in interface JiraWorkflow
public void reset()
reset
in interface JiraWorkflow
public Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsForScreen(FieldScreen fieldScreen)
getActionsForScreen
in interface JiraWorkflow
public int compareTo(JiraWorkflow o)
compareTo
in interface Comparable<JiraWorkflow>
public String getUpdateAuthorName()
JiraWorkflow
getUpdateAuthorName
in interface JiraWorkflow
public ApplicationUser getUpdateAuthor()
JiraWorkflow
UserManager.isUserExisting(com.atlassian.jira.user.ApplicationUser)
if you want to check user's existence.getUpdateAuthor
in interface JiraWorkflow
public Date getUpdatedDate()
JiraWorkflow
getUpdatedDate
in interface JiraWorkflow
public boolean hasDraftWorkflow()
JiraWorkflow
hasDraftWorkflow
in interface JiraWorkflow
true
if this workflow has a draft edit copy.public String getMode()
JiraWorkflow
JiraWorkflow.DRAFT
or JiraWorkflow.LIVE
depending on the workflow implementation.getMode
in interface JiraWorkflow
JiraWorkflow.DRAFT
or JiraWorkflow.LIVE
Copyright © 2002-2021 Atlassian. All Rights Reserved.