com.atlassian.jira.workflow.JiraWorkflow |
Known Indirect Subclasses |
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
Domain object representing the permitted states and transitions of issues.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ACTION_ORIGIN_STEP_ID | May be used as the destination step in common actions, if the action should not result in a step change. | |||||||||
String | ACTION_SCREEN_ATTRIBUTE | ||||||||||
String | ACTION_TYPE_COMMON | ||||||||||
String | ACTION_TYPE_GLOBAL | ||||||||||
String | ACTION_TYPE_INITIAL | ||||||||||
String | ACTION_TYPE_ORDINARY | ||||||||||
String | DEFAULT_WORKFLOW_NAME | ||||||||||
String | DRAFT | ||||||||||
String | JIRA_META_ATTRIBUTE_EDIT_ALLOWED | ||||||||||
String | JIRA_META_ATTRIBUTE_EXCLUDE_RESOLUTION | ||||||||||
String | JIRA_META_ATTRIBUTE_I18N | ||||||||||
String | JIRA_META_ATTRIBUTE_I18N_SUBMIT | ||||||||||
String | JIRA_META_ATTRIBUTE_INCLUDE_RESOLUTION | ||||||||||
String | JIRA_META_ATTRIBUTE_KEY_PREFIX | ||||||||||
String | JIRA_META_ATTRIBUTE_PERMISSION | ||||||||||
String | JIRA_META_UPDATED_DATE | Key used to store the last modification date in the workflow xml | |||||||||
String | JIRA_META_UPDATE_AUTHOR_KEY | ||||||||||
String | JIRA_META_UPDATE_AUTHOR_NAME |
This constant is deprecated.
Use JIRA_META_UPDATE_AUTHOR_KEY instead. Since v6.0.
|
|||||||||
String | LIVE | ||||||||||
String | STEP_STATUS_KEY | ||||||||||
String | WORKFLOW_DESCRIPTION_ATTRIBUTE | ||||||||||
String | WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ACTION_TYPE_ALL | |||||||||||
JIRA_META_ATTRIBUTE_ALLOWED_LIST | Allowed 'jira.*' prefixes for workflow properties. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Get all actions in this workflow, global, common and from steps, whose name matched
name . | |||||||||||
Get all the actions which have a particular step as their unconditional result.
| |||||||||||
Get all the actions in this workflow, global, common and from steps.
| |||||||||||
Get the Status associated with the given StepDescriptor.
| |||||||||||
Get the id of the
Status associated with the given StepDescriptor | |||||||||||
Returns all status ids for this workflow
| |||||||||||
This method is deprecated.
Use
getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor) instead. Since
v7.0.
| |||||||||||
Returns all statuses for this workflow
| |||||||||||
This method is deprecated.
Use
getLinkedStatusObjects() instead. Since v5.0.
| |||||||||||
Get the StepDescriptor linked to the given status for this workflow.
| |||||||||||
This method is deprecated.
Use
getLinkedStep(com.atlassian.jira.issue.status.Status) instead. Since v5.0.
| |||||||||||
Get the next available action id
| |||||||||||
Returns all post-functions of the transition, including the ones on all conditional results,
unconditional results and 'global' (non-result) postfunctions.
| |||||||||||
Returns a collection of all step descriptors that reference the given common action.
| |||||||||||
Returns the most recent author Notice: This method will also return proxy user even when is not
existing.
| |||||||||||
Returns the most recent authors username.
| |||||||||||
Returns the date of the most recent update to this workflow.
| |||||||||||
Determines if this workflow has a draft edit copy.
| |||||||||||
Determine whether this workflow object is currently active.
| |||||||||||
Determines if the workflow is the default JIRA workflow
| |||||||||||
Determines if the workflow is an draft edit of an active workflow.
| |||||||||||
Determines if the workflow can be modifed within JIRA.
| |||||||||||
Determines if the workflow is loaded from XML or the database
| |||||||||||
Remove a step from the workflow.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
java.lang.Comparable
|
May be used as the destination step in common actions, if the action should not result in a step change.
Key used to store the last modification date in the workflow xml
This constant is deprecated.
Use JIRA_META_UPDATE_AUTHOR_KEY
instead. Since v6.0.
Key used to store the last modifications author in the workflow xml
Allowed 'jira.*' prefixes for workflow properties.
Get all actions in this workflow, global, common and from steps, whose name matched name
.
name | of the action to match. This is case-insensitive. |
---|
name
.
Get all the actions which have a particular step as their unconditional result.
Get all the actions in this workflow, global, common and from steps.
Get the Status associated with the given StepDescriptor.
stepDescriptor | the StepDescriptor |
---|
Get the id of the Status
associated with the given StepDescriptor
stepDescriptor | the StepDescriptor |
---|
This method is deprecated.
Use getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor)
instead. Since
v7.0.
Get the Status associated with the given StepDescriptor.
stepDescriptor | the StepDescriptor |
---|
This method is deprecated.
Use getLinkedStatusObjects()
instead. Since v5.0.
Returns all statuses for this workflow
List
of GenericValueGet the StepDescriptor linked to the given status for this workflow.
status | the Status |
---|
This method is deprecated.
Use getLinkedStep(com.atlassian.jira.issue.status.Status)
instead. Since v5.0.
Get the StepDescriptor linked to the given status for this workflow.
status | the Status |
---|
Get the next available action id
Returns all post-functions of the transition, including the ones on all conditional results, unconditional results and 'global' (non-result) postfunctions.
Returns a collection of all step descriptors that reference the given common action.
Returns the most recent author
Notice: This method will also return proxy user even when is not existing. Please useisUserExisting(com.atlassian.jira.user.ApplicationUser)
if you want to check user's existence.Returns the most recent authors username.
Returns the date of the most recent update to this workflow.
Determines if this workflow has a draft edit copy.
true
if this workflow has a draft edit copy.Determine whether this workflow object is currently active.
true
if this workflow object is active.WorkflowException | Runtime Exception indicating a problem in the WorkflowManager. |
---|
Determines if the workflow is the default JIRA workflow
true
if this is the workflow is the default JIRA workflow.
Determines if the workflow is an draft edit of an active workflow.
true
if an draft workflow, false otherwise.Determines if the workflow can be modifed within JIRA.
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. |
---|
Determines if the workflow is loaded from XML or the database
true
if this workflow object is the uneditable system workflow.WorkflowException | Runtime Exception indicating a problem in the WorkflowManager. |
---|
Remove a step from the workflow.
This method will also remove all actions with this step ID as their unconditional result.
true
if the remove was successful