com.atlassian.jira.workflow.function.issue

Class AbstractJiraFunctionProvider

java.lang.Object

com.atlassian.jira.workflow.WorkflowFunctionUtils

com.atlassian.jira.workflow.function.issue.AbstractJiraFunctionProvider

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

Direct Known Subclasses:

AssignToCurrentUserFunction, AssignToLeadFunction, TriggerWebhookFunction, UpdateIssueFieldFunction

@PublicSpi
public abstract class AbstractJiraFunctionProvider
extends WorkflowFunctionUtils
implements com.opensymphony.workflow.FunctionProvider

Abstract base class for all JIRA workflow FunctionProviders (eg. post-functions).

For JIRA FunctionProviders implementing the method:

     public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException;
 

• The 'transientVars' parameter will be populated with values specific to only this invocation, eg. the current user and issue.
• The 'args' parameter will be populated with static configuration values set when the function was first added. Contents are partly source from the plugin factory class, via WorkflowPluginFactory.getDescriptorParams(java.util.Map)

See Also:

WorkflowPluginFactory

Field Summary

Fields inherited from class com.atlassian.jira.workflow.WorkflowFunctionUtils

ORIGINAL_ISSUE_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractJiraFunctionProvider()

Method Summary

Modifier and Type	Method and Description
protected MutableIssue	getIssue(Map transientVars) This method retrieves the (potentially modified) issue object that is being transitioned through workflow.

Methods inherited from class com.atlassian.jira.workflow.WorkflowFunctionUtils

getCaller, getCallerKey, getCallerName, getCallerUser, getCallerUserFromArgs, getUserByKey, populateParamsWithUser, populateParamsWithUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.opensymphony.workflow.FunctionProvider

execute

Constructor Detail

AbstractJiraFunctionProvider

public AbstractJiraFunctionProvider()

Method Detail

getIssue

protected MutableIssue getIssue(Map transientVars)
                         throws DataAccessException

This method retrieves the (potentially modified) issue object that is being transitioned through workflow.

Parameters:

transientVars -

Returns:

the issue object representing the issue the functions shoudl modify

Throws:

DataAccessException - If for some reason the issue doesn't exist.