@PublicApi public interface JiraWorkflow extends Comparable<JiraWorkflow>
Modifier and Type | Method and Description |
---|---|
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()
Deprecated.
Use
getLinkedStatusObjects() instead. Since v5.0. |
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)
Deprecated.
Use
getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor) instead. Since
v7.0. |
List<Status> |
getLinkedStatusObjects()
Returns all statuses for this workflow
|
com.opensymphony.workflow.loader.StepDescriptor |
getLinkedStep(org.ofbiz.core.entity.GenericValue status)
Deprecated.
Use
getLinkedStep(com.atlassian.jira.issue.status.Status) instead. Since v5.0. |
com.opensymphony.workflow.loader.StepDescriptor |
getLinkedStep(Status status)
Get the StepDescriptor linked to the given status for this workflow.
|
String |
getMode()
|
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<com.opensymphony.workflow.loader.StepDescriptor> |
getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)
Returns a collection of all step descriptors that reference the given common action.
|
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.
|
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 |
isDraftWorkflow()
Determines if the workflow is an draft edit of an active 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() |
compareTo
static final String JIRA_META_ATTRIBUTE_KEY_PREFIX
static final String JIRA_META_ATTRIBUTE_PERMISSION
static final String JIRA_META_ATTRIBUTE_EDIT_ALLOWED
static final String JIRA_META_ATTRIBUTE_EXCLUDE_RESOLUTION
static final String JIRA_META_ATTRIBUTE_INCLUDE_RESOLUTION
static final String JIRA_META_ATTRIBUTE_I18N
static final String JIRA_META_ATTRIBUTE_I18N_SUBMIT
static final String JIRA_META_UPDATE_AUTHOR_NAME
JIRA_META_UPDATE_AUTHOR_KEY
instead. Since v6.0.static final String JIRA_META_UPDATE_AUTHOR_KEY
static final String JIRA_META_UPDATED_DATE
static final String[] JIRA_META_ATTRIBUTE_ALLOWED_LIST
static final String STEP_STATUS_KEY
static final String WORKFLOW_DESCRIPTION_ATTRIBUTE
static final String WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE
static final String ACTION_SCREEN_ATTRIBUTE
static final String DEFAULT_WORKFLOW_NAME
static final String ACTION_TYPE_INITIAL
static final String ACTION_TYPE_GLOBAL
static final String ACTION_TYPE_COMMON
static final String ACTION_TYPE_ORDINARY
static final String DRAFT
static final String LIVE
static final Collection<String> ACTION_TYPE_ALL
static final int ACTION_ORIGIN_STEP_ID
String getName()
String getDisplayName()
String getDescription()
com.opensymphony.workflow.loader.WorkflowDescriptor getDescriptor()
Collection<com.opensymphony.workflow.loader.ActionDescriptor> getAllActions()
ActionDescriptor
s.Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsByName(String name)
name
.name
- of the action to match. This is case-insensitive.ActionDescriptor
whose name matched the given name
.Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
boolean removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
This method will also remove all actions with this step ID as their unconditional result.
true
if the remove was successfulcom.opensymphony.workflow.loader.StepDescriptor getLinkedStep(org.ofbiz.core.entity.GenericValue status)
getLinkedStep(com.atlassian.jira.issue.status.Status)
instead. Since v5.0.status
- the Statuscom.opensymphony.workflow.loader.StepDescriptor getLinkedStep(Status status)
status
- the StatusList<org.ofbiz.core.entity.GenericValue> getLinkedStatuses()
getLinkedStatusObjects()
instead. Since v5.0.List
of GenericValue
boolean isActive() throws WorkflowException
true
if this workflow object is active.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.boolean isSystemWorkflow() throws WorkflowException
true
if this workflow object is the uneditable system workflow.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.boolean isEditable() throws WorkflowException
System workflows are never editable. The "published" version of an active workflow is not editable, but the draft version is. Inactive workflows are editable.
true
if this workflow is editable.WorkflowException
- Runtime Exception indicating a problem in the WorkflowManager.boolean isDefault()
true
if this is the workflow is the default JIRA workflow.boolean isDraftWorkflow()
true
if an draft workflow, false otherwise.boolean hasDraftWorkflow()
true
if this workflow has a draft edit copy.int getNextActionId()
Collection<com.opensymphony.workflow.loader.StepDescriptor> getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)
Collection<com.opensymphony.workflow.loader.FunctionDescriptor> getPostFunctionsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Status getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
stepDescriptor
- the StepDescriptor@Deprecated Status getLinkedStatusObject(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor)
instead. Since
v7.0.stepDescriptor
- the StepDescriptorString getLinkedStatusId(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Status
associated with the given StepDescriptor
stepDescriptor
- the StepDescriptorString getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
void reset()
Collection<com.opensymphony.workflow.loader.ActionDescriptor> getActionsForScreen(FieldScreen fieldScreen)
String getUpdateAuthorName()
ApplicationUser getUpdateAuthor()
UserManager.isUserExisting(com.atlassian.jira.user.ApplicationUser)
if you want to check user's existence.Date getUpdatedDate()
Copyright © 2002-2022 Atlassian. All Rights Reserved.