com.atlassian.jira.workflow
Interface JiraWorkflow

All Superinterfaces:

Comparable

All Known Implementing Classes:

AbstractJiraWorkflow

public interface JiraWorkflow

extends Comparable

Field Summary

static Collection	ACTION_TYPE_ALL
static String	ACTION_TYPE_COMMON
static String	ACTION_TYPE_GLOBAL
static String	ACTION_TYPE_INITIAL
static String	ACTION_TYPE_ORDINARY
static String	DEFAULT_WORKFLOW_NAME
static String[]	JIRA_META_ATTRIBUTE_ALLOWED_LIST
static String	JIRA_META_ATTRIBUTE_EDIT_ALLOWED
static String	JIRA_META_ATTRIBUTE_I18N
static String	JIRA_META_ATTRIBUTE_KEY_PREFIX
static String	STEP_STATUS_KEY
static String	WORKFLOW_DESCRIPTION_ATTRIBUTE
static String	WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

Method Summary

Collection	getActionsForScreen(FieldScreen fieldScreen)
Collection	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	getAllActions() Get all the actions in this workflow, global, common and from steps.
String	getDescription()
com.opensymphony.workflow.loader.WorkflowDescriptor	getDescriptor()
org.ofbiz.core.entity.GenericValue	getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
List	getLinkedStatuses() 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.
String	getName()
int	getNextActionId() Get the next available action id
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	reset()
void	store() Persist this workflow object if possible.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

JIRA_META_ATTRIBUTE_KEY_PREFIX

public static final String JIRA_META_ATTRIBUTE_KEY_PREFIX

See Also:

Constant Field Values

JIRA_META_ATTRIBUTE_EDIT_ALLOWED

public static final String JIRA_META_ATTRIBUTE_EDIT_ALLOWED

See Also:

Constant Field Values

JIRA_META_ATTRIBUTE_I18N

public static final String JIRA_META_ATTRIBUTE_I18N

See Also:

Constant Field Values

JIRA_META_ATTRIBUTE_ALLOWED_LIST

public static final String[] JIRA_META_ATTRIBUTE_ALLOWED_LIST

STEP_STATUS_KEY

public static final String STEP_STATUS_KEY

See Also:

Constant Field Values

WORKFLOW_DESCRIPTION_ATTRIBUTE

public static final String WORKFLOW_DESCRIPTION_ATTRIBUTE

See Also:

Constant Field Values

WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

public static final String WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_WORKFLOW_NAME

public static final String DEFAULT_WORKFLOW_NAME

See Also:

Constant Field Values

ACTION_TYPE_INITIAL

public static final String ACTION_TYPE_INITIAL

See Also:

Constant Field Values

ACTION_TYPE_GLOBAL

public static final String ACTION_TYPE_GLOBAL

See Also:

Constant Field Values

ACTION_TYPE_COMMON

public static final String ACTION_TYPE_COMMON

See Also:

Constant Field Values

ACTION_TYPE_ORDINARY

public static final String ACTION_TYPE_ORDINARY

See Also:

Constant Field Values

ACTION_TYPE_ALL

public static final Collection ACTION_TYPE_ALL

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getDescriptor

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

getAllActions

public Collection getAllActions()

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

getActionsWithResult

public 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 List getLinkedStatuses()

Returns all statuses for this workflow

Returns:

a List of GenericValue

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.

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

getStepsForTransition

public 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 String getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

reset

public void reset()

getActionsForScreen

public Collection getActionsForScreen(FieldScreen fieldScreen)