 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
This class is designed for plugins to
implement.
Clients of @PublicSpi can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicSpi as per each product's API policy (clients should refer to each product's API policy for
the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).
Note:
@PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients.
Hence, the guarantee of binary compatibility is different to that of
@PublicApi elements (if an element
is both
@PublicApi and
@PublicSpi, both guarantees apply).
Class Overview
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
getDescriptorParams(java.util.Map)
Summary
| Protected Methods |
|---|
|
MutableIssue
|
getIssue(Map transientVars)
This method retrieves the (potentially modified) issue object that is being transitioned through workflow.
|
Public Constructors
public
AbstractJiraFunctionProvider
()
Protected Methods
protected
MutableIssue
getIssue
(Map transientVars)
This method retrieves the (potentially modified) issue object that is being transitioned through workflow.
Returns
- the issue object representing the issue the functions shoudl modify
