com.atlassian.jira.issue.fields.renderer
Interface RenderableField

All Known Subinterfaces:

CustomField, SummaryField

All Known Implementing Classes:

AbstractTextSystemField, CommentSystemField, CustomFieldImpl, DescriptionSystemField, EnvironmentSystemField, SummarySystemField, WorklogSystemField

@PublicApi
public interface RenderableField

This interface defines the requirements for a field to be used in the Rendering system.

Method Summary

String	getId() Returns the identifier for this RenderableField.
String	getValueFromIssue(Issue issue) Gets the value stored for this field on the provided issue.
boolean	isRenderable() Defines if a field determines itself as renderable.

Method Detail

getId

String getId()

Returns the identifier for this RenderableField.

Returns:

the identifier for this RenderableField.

getValueFromIssue

String getValueFromIssue(Issue issue)

Gets the value stored for this field on the provided issue.

Parameters:

issue - identifies the issue that will contain the value for this field.

Returns:

the value stored on this issue for this field, null if not applicable.

isRenderable

boolean isRenderable()

Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.

Returns:

true if the field is renderable, false otherwise.