com.atlassian.jira.workflow
Interface JiraWorkflow

All Known Implementing Classes:

AbstractJiraWorkflow

public interface JiraWorkflow

Field Summary

static java.util.Collection	ACTION_TYPE_ALL
static java.lang.String	ACTION_TYPE_COMMON
static java.lang.String	ACTION_TYPE_GLOBAL
static java.lang.String	ACTION_TYPE_INITIAL
static java.lang.String	ACTION_TYPE_ORDINARY
static java.lang.String	DEFAULT_WORKFLOW_NAME
static java.lang.String	JIRA_META_ATTRIBUTE_KEY_PREFIX
static java.lang.String	STEP_STATUS_KEY
static java.lang.String	WORKFLOW_DESCRIPTION_ATTRIBUTE
static java.lang.String	WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

Method Summary

java.util.Collection	getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor) Get all the actions which have a particular step as their unconditional result.
java.lang.String	getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
java.util.Collection	getAllActions() Get all the actions in this workflow, global, common and from steps.
java.lang.String	getDescription()
com.opensymphony.workflow.loader.WorkflowDescriptor	getDescriptor()
org.ofbiz.core.entity.GenericValue	getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
java.util.List	getLinkedStatuses()
com.opensymphony.workflow.loader.StepDescriptor	getLinkedStep(org.ofbiz.core.entity.GenericValue status) Get the StepDescriptor linked to the given status for this workflow.
java.lang.String	getName()
int	getNextActionId() Get the next available action id
java.util.Collection	getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action) Returns a collection of all step descriptors that reference the given common action
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	store() Persist this workflow object if possible.

Field Detail

JIRA_META_ATTRIBUTE_KEY_PREFIX

public static final java.lang.String JIRA_META_ATTRIBUTE_KEY_PREFIX

See Also:

Constant Field Values

STEP_STATUS_KEY

public static final java.lang.String STEP_STATUS_KEY

See Also:

Constant Field Values

WORKFLOW_DESCRIPTION_ATTRIBUTE

public static final java.lang.String WORKFLOW_DESCRIPTION_ATTRIBUTE

See Also:

Constant Field Values

WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

public static final java.lang.String WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_WORKFLOW_NAME

public static final java.lang.String DEFAULT_WORKFLOW_NAME

See Also:

Constant Field Values

ACTION_TYPE_INITIAL

public static final java.lang.String ACTION_TYPE_INITIAL

See Also:

Constant Field Values

ACTION_TYPE_GLOBAL

public static final java.lang.String ACTION_TYPE_GLOBAL

See Also:

Constant Field Values

ACTION_TYPE_COMMON

public static final java.lang.String ACTION_TYPE_COMMON

See Also:

Constant Field Values

ACTION_TYPE_ORDINARY

public static final java.lang.String ACTION_TYPE_ORDINARY

See Also:

Constant Field Values

ACTION_TYPE_ALL

public static final java.util.Collection ACTION_TYPE_ALL

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getDescriptor

public com.opensymphony.workflow.loader.WorkflowDescriptor getDescriptor()

getAllActions

public java.util.Collection getAllActions()

Get all the actions in this workflow, global, common and from steps.

getActionsWithResult

public java.util.Collection getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)

Get all the actions which have a particular step as their unconditional result.

removeStep

public boolean removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)

Remove a step from the workflow.

This method will also remove all actions with this step ID as their unconditional result.

getLinkedStep

public com.opensymphony.workflow.loader.StepDescriptor getLinkedStep(org.ofbiz.core.entity.GenericValue status)

Get the StepDescriptor linked to the given status for this workflow.

Returns:

The StepDescriptor linked, or null if no steps are linked to this status.

getLinkedStatuses

public java.util.List getLinkedStatuses()

store

public void store()
           throws WorkflowException

Persist this workflow object if possible.

Throws:

WorkflowException

isActive

public boolean isActive()
                 throws WorkflowException

Determine whether this workflow object is currently active.

Throws:

WorkflowException

isSystemWorkflow

public boolean isSystemWorkflow()
                         throws WorkflowException

Determines if the workflow is loaded from XML or the database

Throws:

WorkflowException

isEditable

public boolean isEditable()
                   throws WorkflowException

Determines if the workflow can be modifed within JIRA.

Returns:

Throws:

WorkflowException

isDefault

public boolean isDefault()

Determines if the workflow is the default JIRA workflow

getNextActionId

public int getNextActionId()

Get the next available action id

Returns:

getStepsForTransition

public java.util.Collection getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)

Returns a collection of all step descriptors that reference the given common action

isInitialAction

public boolean isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

isCommonAction

public boolean isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

isGlobalAction

public boolean isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

isOrdinaryAction

public boolean isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

getLinkedStatus

public org.ofbiz.core.entity.GenericValue getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)

getActionType

public java.lang.String getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)