com.atlassian.jira.issue.fields.rest
Interface FieldHtmlFactory

All Known Implementing Classes:
FieldHtmlFactoryImpl

@ExperimentalApi
public interface FieldHtmlFactory

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

Since:
v5.0.3

Method Summary
 List<FieldHtmlBean> getCreateFields(com.atlassian.crowd.embedded.api.User 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(com.atlassian.crowd.embedded.api.User user, OperationContext operationContext, webwork.action.Action action, Issue issue, boolean retainValues)
          Returns all the edit fields required for the specified issue object.
 List<FieldHtmlBean> getSubTaskCreateFields(com.atlassian.crowd.embedded.api.User 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.
 

Method Detail

getCreateFields

List<FieldHtmlBean> getCreateFields(com.atlassian.crowd.embedded.api.User 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.

Parameters:
user - the remote user
operationContext - the webwork action performing this operation
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

List<FieldHtmlBean> getEditFields(com.atlassian.crowd.embedded.api.User user,
                                  OperationContext operationContext,
                                  webwork.action.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 - the webwork action performing this operation
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

List<FieldHtmlBean> getSubTaskCreateFields(com.atlassian.crowd.embedded.api.User 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.

Parameters:
user - the remote user
operationContext - the webwork action performing this operation
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


Copyright © 2002-2014 Atlassian. All Rights Reserved.