Summary: Methods | [Expand All]
@ExperimentalApi public interface

FieldHtmlFactory

com.atlassian.jira.issue.fields.rest.FieldHtmlFactory
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Helper factory to get a list of all the fields required for create, edit and creating subtasks.

Summary

Public Methods
List<FieldHtmlBean> getCreateFields(ApplicationUser user, OperationContext operationContext, 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, Action action, Issue issue, boolean retainValues)
Returns all the edit fields required for the specified issue object.
List<FieldHtmlBean> getInlineEditFields(ApplicationUser user, OperationContext operationContext, Action action, Issue issue, boolean retainValues)
Returns all edit fields applicable for inline editing.
List<FieldHtmlBean> getLinkedIssueCreateFields(ApplicationUser user, OperationContext operationContext, 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, 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.

Public Methods

public List<FieldHtmlBean> getCreateFields (ApplicationUser user, OperationContext operationContext, 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.

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

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

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.

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

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

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.

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

public List<FieldHtmlBean> getLinkedIssueCreateFields (ApplicationUser user, OperationContext operationContext, 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. 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

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

public List<FieldHtmlBean> getSubTaskCreateFields (ApplicationUser user, OperationContext operationContext, 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.

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