com.atlassian.jira.issue.fields.screen
Interface FieldScreenRendererFactory

All Known Implementing Classes:
FieldScreenRendererFactoryImpl

public interface FieldScreenRendererFactory

A factory for obtaining FieldScreenRenderer's.


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
 

Method Detail

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(User remoteUser,
                                           Issue issue,
                                           IssueOperation issueOperation,
                                           boolean onlyShownCustomFields)
This is the prefered way of getting a FieldScreenRenderer

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

FieldScreenRenderer getFieldScreenRenderer(User remoteUser,
                                           Issue issue,
                                           com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Used when transitioning an issue through workflow.

Parameters:
remoteUser - the current user
issue - the current issue
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 -
Returns:
a FieldScreenRenderer without any tabs.

getFieldScreenRenderer

FieldScreenRenderer getFieldScreenRenderer(Collection issues,
                                           com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Used when transitioning a collections of issues through workflow

Parameters:
actionDescriptor -
Returns:
a BulkFieldScreenRenderer - aggregates the tabs and fields for the specified collection of issues

getFieldScreenRenderer

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. The returned Field Renderer places all given fields on one tab.



Copyright © 2002-2009 Atlassian. All Rights Reserved.