com.atlassian.jira.issue.fields.screen

Interface FieldScreenRendererFactory

All Known Implementing Classes:

FieldScreenRendererFactoryImpl

@PublicApi
public interface FieldScreenRendererFactory

A factory for obtaining FieldScreenRenderers.

Method Summary

Modifier and Type	Method and Description
FieldScreenRenderer	getFieldScreenRenderer(ApplicationUser remoteUser, Issue issue, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.opensymphony.workflow.loader.ActionDescriptor) instead. Since v6.2.
FieldScreenRenderer	getFieldScreenRenderer(ApplicationUser remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields) Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation) instead. Use FieldPredicates.isCustomField() in the version that takes a predicate if you only want custom fields. Since v6.2.
FieldScreenRenderer	getFieldScreenRenderer(ApplicationUser remoteUser, Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate) Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation, com.atlassian.jira.util.Predicate) instead. Since v6.2.
FieldScreenRenderer	getFieldScreenRenderer(Collection<Issue> issues, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Get a renderer that can be used to render the fields when transitioning a collection of issues through workflow.
FieldScreenRenderer	getFieldScreenRenderer(Issue issue) Used when need to populate a field without showing a screen - e.g.
FieldScreenRenderer	getFieldScreenRenderer(Issue issue, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.
FieldScreenRenderer	getFieldScreenRenderer(Issue issue, IssueOperation issueOperation) Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.
FieldScreenRenderer	getFieldScreenRenderer(Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate) Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.
FieldScreenRenderer	getFieldScreenRenderer(List<String> fieldIds, ApplicationUser remoteUser, Issue issue, IssueOperation issueOperation) Returns a FieldScreenRenderer that represents a 'field screen' with the fields the ids of which are in fieldIds.

Method Detail

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Issue issue,
                                           IssueOperation issueOperation)

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Parameters:

issue - the issue to be rendered.

issueOperation - the current issue operation.

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Issue issue,
                                           IssueOperation issueOperation,
                                           Predicate<? super Field> predicate)

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Only the fields that match the passed predicate will be included in the returned FieldScreenRenderer.

Parameters:

issue - the issue to be rendered.

issueOperation - the current issue operation.

predicate - only fields that cause ths predicate to return true will be returned in the FieldScreenRenderer

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(ApplicationUser remoteUser,
                                           Issue issue,
                                           IssueOperation issueOperation,
                                           Predicate<? super Field> predicate)

Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation, com.atlassian.jira.util.Predicate) instead. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments. Only the fields that match the passed predicate will be included in the returned FieldScreenRenderer.

Parameters:

remoteUser - the current user

issue - the issue to be rendered.

issueOperation - the current issue operation.

predicate - only fields that cause ths predicate to return true will be returned in the FieldScreenRenderer

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

@Deprecated
FieldScreenRenderer getFieldScreenRenderer(ApplicationUser remoteUser,
                                                       Issue issue,
                                                       IssueOperation issueOperation,
                                                       boolean onlyShownCustomFields)

Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation) instead. Use FieldPredicates.isCustomField() in the version that takes a predicate if you only want custom fields. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Parameters:

remoteUser - the current user

issue - the issue to be rendered.

issueOperation - the current issue operation.

onlyShownCustomFields - if true will only return custom fields in the FieldScreenRenderer, otherwise all fields will be returned.

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(ApplicationUser remoteUser,
                                           Issue issue,
                                           com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.opensymphony.workflow.loader.ActionDescriptor) instead. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.

Parameters:

remoteUser - the current user

issue - the issue to be rendered.

actionDescriptor - the current workflow action descriptor

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Issue issue,
                                           com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.

Parameters:

issue - the issue to be rendered.

actionDescriptor - the current workflow action descriptor

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Issue issue)

Used when need to populate a field without showing a screen - e.g. When using a UpdateIssueFieldFunction in workflow

Parameters:

issue - the currentIssue.

Returns:

a FieldScreenRenderer without any tabs.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Collection<Issue> issues,
                                           com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Get a renderer that can be used to render the fields when transitioning a collection of issues through workflow.

Parameters:

issues - the issues to be rendered.

actionDescriptor - current workflow action descriptor

Returns:

a BulkFieldScreenRenderer - aggregates the tabs and fields for the specified collection of issues

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(List<String> fieldIds,
                                           ApplicationUser remoteUser,
                                           Issue issue,
                                           IssueOperation issueOperation)

Returns a FieldScreenRenderer that represents a 'field screen' with the fields the ids of which are in fieldIds. The returned Field Renderer places all given fields on one tab.

Parameters:

fieldIds - the fields to create the renderer for.

remoteUser - the current user

issue - the issue to be rendered.

issueOperation - the current issue operation.

Returns:

a FieldScreenRenderer for the passed fields.