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

java.lang.Object
  extended by com.atlassian.jira.workflow.WorkflowFunctionUtils
      extended by com.atlassian.jira.workflow.function.issue.AbstractJiraFunctionProvider
All Implemented Interfaces:
com.opensymphony.workflow.FunctionProvider
Direct Known Subclasses:
AssignToCurrentUserFunction, AssignToLeadFunction, UpdateIssueFieldFunction

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;
 

See Also:
WorkflowPluginFactory

Field Summary
 
Fields inherited from class com.atlassian.jira.workflow.WorkflowFunctionUtils
ORIGINAL_ISSUE_KEY, ORIGNAL_ISSUE_KEY
 
Constructor Summary
AbstractJiraFunctionProvider()
           
 
Method Summary
protected  MutableIssue getIssue(java.util.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, getCallerName
 
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(java.util.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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.