com.atlassian.jira.workflow.function
Class ATransitionFunction

java.lang.Object
  com.atlassian.jira.workflow.function.ATransitionFunction

All Implemented Interfaces:

ITransitionFunction

Direct Known Subclasses:

APropagateVersion, ATransitionValidator, ResolutionCommentValidator

public abstract class ATransitionFunction
extends java.lang.Object
implements ITransitionFunction

FQCN : com.atlassian.jira.workflow.function.ATransitionFunction

Since:

Author:

Kaamelot

Field Summary

protected com.opensymphony.workflow.loader.ActionDescriptor	actionDescriptor
protected com.atlassian.jira.issue.CustomFieldManager	customFieldManager
protected com.atlassian.jira.issue.fields.FieldManager	fieldManager
protected com.atlassian.jira.issue.fields.screen.FieldScreenRenderer	fieldScreenRenderer
protected static com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactory	fieldScreenRendererFactory
protected com.opensymphony.workflow.InvalidInputException	invalidInputException
protected com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager	issueTypeScreenSchemeManager
protected static org.apache.log4j.Category	log

Constructor Summary

ATransitionFunction()

Method Summary

void	addErrors(com.opensymphony.workflow.InvalidInputException _invalidInputException)
void	addErrors(java.util.Map _errors)
com.opensymphony.workflow.loader.ActionDescriptor	getActionDescriptor(java.util.Map transientVars)
java.util.Map	getFieldErrors()
com.atlassian.jira.issue.fields.screen.FieldScreen	getFieldScreen(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
com.atlassian.jira.issue.fields.screen.FieldScreenRenderer	getFieldScreenRenderer() Instead of getScreen(), getFieldScreenRenderer() returns the screen only with visible fields (depending on the RemoteUser)
com.atlassian.jira.web.bean.I18nBean	getI18nBean()
java.util.Collection	getI18nLocations()
com.opensymphony.workflow.InvalidInputException	getInvalidInputException()
com.atlassian.jira.issue.MutableIssue	getIssue()
com.atlassian.jira.issue.MutableIssue	getIssue(java.util.Map transientVars)
com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager	getIssueTypeScreenSchemeManager()
com.opensymphony.user.User	getRemoteUser()
com.atlassian.jira.issue.fields.screen.FieldScreen	getScreen()
protected java.lang.Object	getValueOfModifiedCustomField(java.lang.String _customFieldName)
protected java.lang.Object	getValueOfModifiedField(com.atlassian.jira.issue.fields.Field _field)
protected java.lang.Object	getValueOfModifiedField(java.lang.String _fieldId)
void	init(java.util.Map transientVars, java.util.Map args, com.opensymphony.module.propertyset.PropertySet ps) Assume Validator initialisation
static com.opensymphony.workflow.loader.ValidatorDescriptor	makeDescriptor(java.lang.String permission, java.lang.String _validatorFQCN)
protected void	setError(com.atlassian.jira.issue.fields.Field field, java.lang.String errmsg)
protected void	setError(java.lang.String fieldId, java.lang.String errmsg)
protected void	setErrorOnCustomField(java.lang.String _customfieldName, java.lang.String errmsg)
void	setFieldErrors(java.util.Map fieldErrors)
void	setInvalidInputException(com.opensymphony.workflow.InvalidInputException invalidInputException) Force Exception on Validator
protected void	setIssue(com.atlassian.jira.issue.MutableIssue _issue)
void	throwOnError() Defaultly called by ATransitionFunction.validate()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.log4j.Category log

fieldManager

protected com.atlassian.jira.issue.fields.FieldManager fieldManager

customFieldManager

protected com.atlassian.jira.issue.CustomFieldManager customFieldManager

fieldScreenRendererFactory

protected static com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactory fieldScreenRendererFactory

actionDescriptor

protected com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor

fieldScreenRenderer

protected com.atlassian.jira.issue.fields.screen.FieldScreenRenderer fieldScreenRenderer

issueTypeScreenSchemeManager

protected com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager issueTypeScreenSchemeManager

invalidInputException

protected com.opensymphony.workflow.InvalidInputException invalidInputException

Constructor Detail

ATransitionFunction

public ATransitionFunction()

Method Detail

init

public void init(java.util.Map transientVars,
                 java.util.Map args,
                 com.opensymphony.module.propertyset.PropertySet ps)
          throws com.opensymphony.workflow.InvalidInputException,
                 com.opensymphony.workflow.WorkflowException

Description copied from interface: ITransitionFunction

Assume Validator initialisation

Specified by:

init in interface ITransitionFunction

args - Arguments issued from Validator Parameters in from Workflow Description

ps - PorpertySet

Throws:

com.opensymphony.workflow.InvalidInputException

com.opensymphony.workflow.WorkflowException

getActionDescriptor

public com.opensymphony.workflow.loader.ActionDescriptor getActionDescriptor(java.util.Map transientVars)

Specified by:

getActionDescriptor in interface ITransitionFunction

getScreen

public com.atlassian.jira.issue.fields.screen.FieldScreen getScreen()

Specified by:

getScreen in interface ITransitionFunction

Returns:

FieldScreen as it is defined in the FieldScreenScheme for this Workflow Action

getFieldScreen

public com.atlassian.jira.issue.fields.screen.FieldScreen getFieldScreen(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Parameters:

actionDescriptor -

Returns:

See Also:

com.atlassian.plugin.util.WorkflowUtils#getFieldScreen(ActionDescriptor)

getFieldScreenRenderer

public com.atlassian.jira.issue.fields.screen.FieldScreenRenderer getFieldScreenRenderer()

Instead of getScreen(), getFieldScreenRenderer() returns the screen only with visible fields (depending on the RemoteUser)

Returns:

getIssue

public com.atlassian.jira.issue.MutableIssue getIssue()

Specified by:

getIssue in interface ITransitionFunction

Returns:

Issue concerned by the Validation

setIssue

protected void setIssue(com.atlassian.jira.issue.MutableIssue _issue)

getIssue

public com.atlassian.jira.issue.MutableIssue getIssue(java.util.Map transientVars)

Specified by:

getIssue in interface ITransitionFunction

Returns:

Issue concerned by the Validation

getI18nBean

public com.atlassian.jira.web.bean.I18nBean getI18nBean()

Specified by:

getI18nBean in interface ITransitionFunction

Returns:

I18Bean in dependence with called validator

getI18nLocations

public java.util.Collection getI18nLocations()

getValueOfModifiedCustomField

protected java.lang.Object getValueOfModifiedCustomField(java.lang.String _customFieldName)

getValueOfModifiedField

protected java.lang.Object getValueOfModifiedField(com.atlassian.jira.issue.fields.Field _field)

getValueOfModifiedField

protected java.lang.Object getValueOfModifiedField(java.lang.String _fieldId)

throwOnError

public void throwOnError()
                  throws com.opensymphony.workflow.InvalidInputException

Description copied from interface: ITransitionFunction

Defaultly called by ATransitionFunction.validate()

Specified by:

throwOnError in interface ITransitionFunction

Throws:

com.opensymphony.workflow.InvalidInputException

setErrorOnCustomField

protected void setErrorOnCustomField(java.lang.String _customfieldName,
                                     java.lang.String errmsg)

setError

protected void setError(java.lang.String fieldId,
                        java.lang.String errmsg)

setError

protected void setError(com.atlassian.jira.issue.fields.Field field,
                        java.lang.String errmsg)

addErrors

public void addErrors(java.util.Map _errors)

addErrors

public void addErrors(com.opensymphony.workflow.InvalidInputException _invalidInputException)

getInvalidInputException

public com.opensymphony.workflow.InvalidInputException getInvalidInputException()

Specified by:

getInvalidInputException in interface ITransitionFunction

Returns:

inner Exception built occured during validation

setInvalidInputException

public void setInvalidInputException(com.opensymphony.workflow.InvalidInputException invalidInputException)

Description copied from interface: ITransitionFunction

Force Exception on Validator

Specified by:

setInvalidInputException in interface ITransitionFunction

getRemoteUser

public com.opensymphony.user.User getRemoteUser()

makeDescriptor

public static com.opensymphony.workflow.loader.ValidatorDescriptor makeDescriptor(java.lang.String permission,
                                                                                  java.lang.String _validatorFQCN)

getFieldErrors

public java.util.Map getFieldErrors()

setFieldErrors

public void setFieldErrors(java.util.Map fieldErrors)

getIssueTypeScreenSchemeManager

public com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager getIssueTypeScreenSchemeManager()