com.atlassian.jira.issue.fields.screen
Class FieldScreenRendererFactoryImpl

java.lang.Object
  com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactoryImpl

All Implemented Interfaces:

FieldScreenRendererFactory

public class FieldScreenRendererFactoryImpl

extends Object

implements FieldScreenRendererFactory

Default implementation of the FieldScreenRendererFactory.

Constructor Summary

FieldScreenRendererFactoryImpl(FieldManager fieldManager, FieldLayoutManager fieldLayoutManager, IssueTypeScreenSchemeManager issueTypeScreenSchemeManager, FieldScreenManager fieldScreenManager)

Method Summary

FieldScreenRenderer	getFieldScreenRenderer(Collection issues, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Used when transitioning a collections of issues through workflow
FieldScreenRenderer	getFieldScreenRenderer(Issue issue) Used when need to populate a field without showing a screen - e.g.
FieldScreenRenderer	getFieldScreenRenderer(List fieldIds, User remoteUser, Issue issue, IssueOperation issueOperation) Returns a FieldScreenRenderer that represents a 'field screen' with the fields the ids of which are in fieldIds.
FieldScreenRenderer	getFieldScreenRenderer(User remoteUser, Issue issue, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Used when transitioning an issue through workflow.
FieldScreenRenderer	getFieldScreenRenderer(User remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields) This is the prefered way of getting a FieldScreenRenderer

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldScreenRendererFactoryImpl

public FieldScreenRendererFactoryImpl(FieldManager fieldManager,
                                      FieldLayoutManager fieldLayoutManager,
                                      IssueTypeScreenSchemeManager issueTypeScreenSchemeManager,
                                      FieldScreenManager fieldScreenManager)

Method Detail

getFieldScreenRenderer

public FieldScreenRenderer getFieldScreenRenderer(User remoteUser,
                                                  Issue issue,
                                                  IssueOperation issueOperation,
                                                  boolean onlyShownCustomFields)

Description copied from interface: FieldScreenRendererFactory

This is the prefered way of getting a FieldScreenRenderer

Specified by:

getFieldScreenRenderer in interface FieldScreenRendererFactory

Parameters:

remoteUser - the current user

issue - the current issue

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

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

Description copied from interface: FieldScreenRendererFactory

Used when transitioning an issue through workflow.

Specified by:

getFieldScreenRenderer in interface FieldScreenRendererFactory

Parameters:

remoteUser - the current user

issue - the current issue

actionDescriptor - the current workflow action descriptor

Returns:

a FieldScreenRenderer for the provided context.

getFieldScreenRenderer

public FieldScreenRenderer getFieldScreenRenderer(Issue issue)

Description copied from interface: FieldScreenRendererFactory

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

Specified by:

getFieldScreenRenderer in interface FieldScreenRendererFactory

Parameters:

issue -

Returns:

a FieldScreenRenderer without any tabs.

getFieldScreenRenderer

public FieldScreenRenderer getFieldScreenRenderer(Collection issues,
                                                  com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: FieldScreenRendererFactory

Used when transitioning a collections of issues through workflow

Specified by:

getFieldScreenRenderer in interface FieldScreenRendererFactory

Parameters:

actionDescriptor -

Returns:

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

getFieldScreenRenderer

public FieldScreenRenderer getFieldScreenRenderer(List fieldIds,
                                                  User remoteUser,
                                                  Issue issue,
                                                  IssueOperation issueOperation)

Description copied from interface: FieldScreenRendererFactory

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.

Specified by:

getFieldScreenRenderer in interface FieldScreenRendererFactory