com.atlassian.jira.issue.fields.rest

Class FieldHtmlFactoryImpl

java.lang.Object

com.atlassian.jira.issue.fields.rest.FieldHtmlFactoryImpl

All Implemented Interfaces:

FieldHtmlFactory

public class FieldHtmlFactoryImpl
extends Object
implements FieldHtmlFactory

Note: There's no unit tests in JIRA source but this is already tested quite heavily via func tests in the quick-edit plugin as well as webdriver tests for quick edit in JIRA source.

Since:

5.0.3

Constructor Summary

Constructors

Constructor and Description
FieldHtmlFactoryImpl(I18nHelper.BeanFactory beanFactory, FieldManager fieldManager, FieldScreenRendererFactory fieldScreenRendererFactory, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method and Description
List<FieldHtmlBean>	getCreateFields(ApplicationUser user, OperationContext operationContext, webwork.action.Action action, MutableIssue newIssueObject, boolean retainValues, List<String> fieldsToRetain) Returns a list of fields on the create screen as specified by the newIssueObject skeleton (it contains the project and issue type context) including the project and issue type fields.
List<FieldHtmlBean>	getEditFields(ApplicationUser user, OperationContext operationContext, webwork.action.Action action, Issue issue, boolean retainValues) Returns all the edit fields required for the specified issue object.
List<FieldHtmlBean>	getInlineEditFields(ApplicationUser user, OperationContext operationContext, webwork.action.Action action, Issue issue, boolean retainValues) Returns all edit fields applicable for inline editing.
List<FieldHtmlBean>	getLinkedIssueCreateFields(ApplicationUser user, OperationContext operationContext, webwork.action.Action action, MutableIssue newIssueObject, Issue sourceIssue, boolean retainValues, List<String> fieldsToRetain) Returns a list of fields on the create screen as specified by the newIssueObject skeleton (it contains the project and issue type context) including the project, issue type and issue links fields.
List<FieldHtmlBean>	getSubTaskCreateFields(ApplicationUser user, OperationContext operationContext, webwork.action.Action action, MutableIssue newIssueObject, boolean retainValues, List<String> fieldsToRetain) This essentially returns the same as the #getCreateFields(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.customfields.OperationContext, webwork.action.Action, com.atlassian.jira.issue.MutableIssue, boolean, java.util.List) method but it strips out certain fields such as the project selector.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldHtmlFactoryImpl

public FieldHtmlFactoryImpl(I18nHelper.BeanFactory beanFactory,
                            FieldManager fieldManager,
                            FieldScreenRendererFactory fieldScreenRendererFactory,
                            PermissionManager permissionManager)

Method Detail

getCreateFields

public List<FieldHtmlBean> getCreateFields(ApplicationUser user,
                                           OperationContext operationContext,
                                           webwork.action.Action action,
                                           MutableIssue newIssueObject,
                                           boolean retainValues,
                                           List<String> fieldsToRetain)

Description copied from interface: FieldHtmlFactory

Returns a list of fields on the create screen as specified by the newIssueObject skeleton (it contains the project and issue type context) including the project and issue type fields.

Specified by:

getCreateFields in interface FieldHtmlFactory

Parameters:

user - the remote user

operationContext - holding context information about the action

action - the webwork action performing this operation

newIssueObject - skeleton issue object

retainValues - If we should keep all the field values when switching from full back to quick edit

fieldsToRetain - List of fields to retain when creating multiple issues in a row

Returns:

A list of FieldHtmlBeans

getEditFields

public List<FieldHtmlBean> getEditFields(ApplicationUser user,
                                         OperationContext operationContext,
                                         webwork.action.Action action,
                                         Issue issue,
                                         boolean retainValues)

Description copied from interface: FieldHtmlFactory

Returns all the edit fields required for the specified issue object. This also includes a comment field if the user has permission to add comments.

Specified by:

getEditFields in interface FieldHtmlFactory

Parameters:

user - the remote user

operationContext - holding context information about the action

action - the webwork action performing this operation

issue - the issue being edited. Used to populate the field values.

retainValues - If we should keep all the field values when switching from full back to quick edit

Returns:

A list of FieldHtmlBeans

getInlineEditFields

public List<FieldHtmlBean> getInlineEditFields(ApplicationUser user,
                                               OperationContext operationContext,
                                               webwork.action.Action action,
                                               Issue issue,
                                               boolean retainValues)

Description copied from interface: FieldHtmlFactory

Returns all edit fields applicable for inline editing. That is edit fields and non-empty custom fields. This also includes a comment field if the user has permission to add comments.

Specified by:

getInlineEditFields in interface FieldHtmlFactory

Parameters:

user - the remote user

operationContext - holding context information about the action

action - the webwork action performing this operation

issue - the issue being edited. Used to populate the field values.

retainValues - If we should keep all the field values when switching from full back to quick edit

Returns:

A list of FieldHtmlBeans

getSubTaskCreateFields

public List<FieldHtmlBean> getSubTaskCreateFields(ApplicationUser user,
                                                  OperationContext operationContext,
                                                  webwork.action.Action action,
                                                  MutableIssue newIssueObject,
                                                  boolean retainValues,
                                                  List<String> fieldsToRetain)

Description copied from interface: FieldHtmlFactory

This essentially returns the same as the #getCreateFields(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.customfields.OperationContext, webwork.action.Action, com.atlassian.jira.issue.MutableIssue, boolean, java.util.List) method but it strips out certain fields such as the project selector.

Specified by:

getSubTaskCreateFields in interface FieldHtmlFactory

Parameters:

user - the remote user

operationContext - holding context information about the action

action - the webwork action performing this operation

newIssueObject - skeleton issue object

retainValues - If we should keep all the field values when switching from full back to quick edit

fieldsToRetain - List of fields to retain when creating multiple issues in a row

Returns:

A list of FieldHtmlBeans

getLinkedIssueCreateFields

public List<FieldHtmlBean> getLinkedIssueCreateFields(ApplicationUser user,
                                                      OperationContext operationContext,
                                                      webwork.action.Action action,
                                                      MutableIssue newIssueObject,
                                                      Issue sourceIssue,
                                                      boolean retainValues,
                                                      List<String> fieldsToRetain)

Description copied from interface: FieldHtmlFactory

Returns a list of fields on the create screen as specified by the newIssueObject skeleton (it contains the project and issue type context) including the project, issue type and issue links fields. This also includes Summary and Description fields even if they are not configured on create screen. Those fields will be prefilled by the corresponding values pulled from the source issue The issue links field will be prefilled by a link to the source issue

Specified by:

getLinkedIssueCreateFields in interface FieldHtmlFactory

Parameters:

user - the remote user

operationContext - holding context information about the action

action - the webwork action performing this operation

newIssueObject - skeleton issue object

sourceIssue - the issue to get field values to prefill the returned fields

retainValues - If we should keep all the field values when switching from full back to quick edit

fieldsToRetain - List of fields to retain when creating multiple issues in a row

Returns:

A list of FieldHtmlBeans