public class

OfBizWorkflowDescriptorStore

extends Object
implements WorkflowDescriptorStore
java.lang.Object
   ↳ com.atlassian.jira.workflow.OfBizWorkflowDescriptorStore

Class Overview

Provides an OfBiz implementation of a WorkflowDescriptorStore

Summary

Constants
String DESCRIPTOR_ENTITY_FIELD
String NAME_ENTITY_FIELD
String WORKFLOW_ENTITY_NAME
Public Constructors
OfBizWorkflowDescriptorStore(OfBizDelegator ofBizDelegator)
Public Methods
List<JiraWorkflowDTO> getAllJiraWorkflowDTOs()
Returns a list of all the workflows stored in the underlying store.
ImmutableWorkflowDescriptor getWorkflow(String name)
Retrieves a com.opensymphony.workflow.loader.WorkflowDescriptor from the underlying store.
String[] getWorkflowNames()
Returns an array of all the workflowNames stored.
boolean removeWorkflow(String name)
Removes a workflow from the underlying store.
boolean saveWorkflow(String name, WorkflowDescriptor workflowDescriptor, boolean replace)
Saves or updates a workflowDescriptor.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.workflow.WorkflowDescriptorStore

Constants

public static final String DESCRIPTOR_ENTITY_FIELD

Constant Value: "descriptor"

public static final String NAME_ENTITY_FIELD

Constant Value: "name"

public static final String WORKFLOW_ENTITY_NAME

Constant Value: "Workflow"

Public Constructors

public OfBizWorkflowDescriptorStore (OfBizDelegator ofBizDelegator)

Public Methods

public List<JiraWorkflowDTO> getAllJiraWorkflowDTOs ()

Returns a list of all the workflows stored in the underlying store.

Returns

public ImmutableWorkflowDescriptor getWorkflow (String name)

Retrieves a com.opensymphony.workflow.loader.WorkflowDescriptor from the underlying store. Returns null if no WorkflowDescriptor can be found

Parameters
name The workflow name
Returns
  • Null or the matching WorkflowDescriptor
Throws
FactoryException

public String[] getWorkflowNames ()

Returns an array of all the workflowNames stored.

Returns
  • an array of all the workflowNames stored.

public boolean removeWorkflow (String name)

Removes a workflow from the underlying store.

Parameters
name The workflow name
Returns
  • true if any records were delete, false otherwise

public boolean saveWorkflow (String name, WorkflowDescriptor workflowDescriptor, boolean replace)

Saves or updates a workflowDescriptor. If the descriptor already exists, and the replace flag is true, an update will be done. Otherwise, this method will simply create a new value in the database (if none exists yet).

Parameters
name The name of the workflow
workflowDescriptor The com.opensymphony.workflow.loader.WorkflowDescriptor to save/update in the underlying store
replace true if an update should be done, if the workflow already exists, false otherwise
Returns
  • true if the update was carried out successfully, false otherwise
Throws
DataAccessException