com.atlassian.jira.workflow
Interface JiraWorkflow

All Known Implementing Classes:
AbstractJiraWorkflow, ConfigurableJiraWorkflow, DefaultJiraWorkflow

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

static final java.lang.String JIRA_META_ATTRIBUTE_KEY_PREFIX
See Also:
Constant Field Values

STEP_STATUS_KEY

static final java.lang.String STEP_STATUS_KEY
See Also:
Constant Field Values

WORKFLOW_DESCRIPTION_ATTRIBUTE

static final java.lang.String WORKFLOW_DESCRIPTION_ATTRIBUTE
See Also:
Constant Field Values

WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE

static final java.lang.String WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE
See Also:
Constant Field Values

DEFAULT_WORKFLOW_NAME

static final java.lang.String DEFAULT_WORKFLOW_NAME
See Also:
Constant Field Values

ACTION_TYPE_INITIAL

static final java.lang.String ACTION_TYPE_INITIAL
See Also:
Constant Field Values

ACTION_TYPE_GLOBAL

static final java.lang.String ACTION_TYPE_GLOBAL
See Also:
Constant Field Values

ACTION_TYPE_COMMON

static final java.lang.String ACTION_TYPE_COMMON
See Also:
Constant Field Values

ACTION_TYPE_ORDINARY

static final java.lang.String ACTION_TYPE_ORDINARY
See Also:
Constant Field Values

ACTION_TYPE_ALL

static final java.util.Collection ACTION_TYPE_ALL
Method Detail

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

getDescriptor

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

getAllActions

java.util.Collection getAllActions()
Get all the actions in this workflow, global, common and from steps.


getActionsWithResult

java.util.Collection getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get all the actions which have a particular step as their unconditional result.


removeStep

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

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

java.util.List getLinkedStatuses()

store

void store()
           throws WorkflowException
Persist this workflow object if possible.

Throws:
WorkflowException

isActive

boolean isActive()
                 throws WorkflowException
Determine whether this workflow object is currently active.

Throws:
WorkflowException

isSystemWorkflow

boolean isSystemWorkflow()
                         throws WorkflowException
Determines if the workflow is loaded from XML or the database

Throws:
WorkflowException

isEditable

boolean isEditable()
                   throws WorkflowException
Determines if the workflow can be modifed within JIRA.

Returns:
Throws:
WorkflowException

isDefault

boolean isDefault()
Determines if the workflow is the default JIRA workflow


getNextActionId

int getNextActionId()
Get the next available action id

Returns:

getStepsForTransition

java.util.Collection getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)
Returns a collection of all step descriptors that reference the given common action


isInitialAction

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

isCommonAction

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

isGlobalAction

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

isOrdinaryAction

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

getLinkedStatus

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

getActionType

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


Copyright © 2002-2006 Atlassian. All Rights Reserved.