com.atlassian.jira.issue.fields.layout.field
Interface FieldLayout

All Known Subinterfaces:

EditableDefaultFieldLayout, EditableFieldLayout

public interface FieldLayout

NOTE: This is referred to as Field Configuration in the UI.

Method Summary

String	getDescription()
FieldLayoutItem	getFieldLayoutItem(OrderableField orderableField)
FieldLayoutItem	getFieldLayoutItem(String fieldId)
List<FieldLayoutItem>	getFieldLayoutItems()
org.ofbiz.core.entity.GenericValue	getGenericValue()
List<Field>	getHiddenFields(Project project, List<String> issueTypeIds)
List<Field>	getHiddenFields(com.atlassian.crowd.embedded.api.User remoteUser, org.ofbiz.core.entity.GenericValue project, List<String> issueTypeIds) Deprecated. Use getHiddenFields(com.atlassian.jira.project.Project, java.util.List). Since v4.3
List<Field>	getHiddenFields(com.atlassian.crowd.embedded.api.User remoteUser, Project project, List<String> issueTypeIds) Deprecated. Use getHiddenFields(com.atlassian.jira.project.Project, java.util.List). Since v4.3
Long	getId()
String	getName()
String	getRendererTypeForField(String fieldId)
List<FieldLayoutItem>	getRequiredFieldLayoutItems(Project project, List<String> issueTypes)
List<FieldLayoutItem>	getRequiredFieldLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser, org.ofbiz.core.entity.GenericValue project, List<String> issueTypes) Deprecated. Use getRequiredFieldLayoutItems(com.atlassian.jira.project.Project, java.util.List). Since v4.3
List<FieldLayoutItem>	getVisibleCustomFieldLayoutItems(Project project, List<String> issueTypes) Returns the list of Custom Fields in this Field Layout that are both visible and applicable to the given context (of project and Issue types).
List<FieldLayoutItem>	getVisibleCustomFieldLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser, org.ofbiz.core.entity.GenericValue project, List<String> issueTypes) Deprecated. use getVisibleCustomFieldLayoutItems(Project, List). Since v4.3
List<FieldLayoutItem>	getVisibleLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser, Project project, List<String> issueTypes)
boolean	isDefault() Returns true if this is the default FieldLayout.
boolean	isFieldHidden(String fieldId)

Method Detail

getId

Long getId()

getName

String getName()

getDescription

String getDescription()

getFieldLayoutItems

List<FieldLayoutItem> getFieldLayoutItems()

getGenericValue

org.ofbiz.core.entity.GenericValue getGenericValue()

getFieldLayoutItem

FieldLayoutItem getFieldLayoutItem(OrderableField orderableField)

getFieldLayoutItem

FieldLayoutItem getFieldLayoutItem(String fieldId)

getVisibleLayoutItems

List<FieldLayoutItem> getVisibleLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser,
                                            Project project,
                                            List<String> issueTypes)

getVisibleCustomFieldLayoutItems

List<FieldLayoutItem> getVisibleCustomFieldLayoutItems(Project project,
                                                       List<String> issueTypes)

Returns the list of Custom Fields in this Field Layout that are both visible and applicable to the given context (of project and Issue types).

Parameters:

project - The project context

issueTypes - The Issue Types for context

Returns:

the list of visible Custom Fields applicable to the given context (of project and Issue types).

getVisibleCustomFieldLayoutItems

List<FieldLayoutItem> getVisibleCustomFieldLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser,
                                                       org.ofbiz.core.entity.GenericValue project,
                                                       List<String> issueTypes)

Deprecated. use getVisibleCustomFieldLayoutItems(Project, List). Since v4.3

Returns the list of Custom Fields in this Field Layout that are both visible and applicable to the given context (of project and Issue types).

Parameters:

remoteUser - Ignored

project - The project context

issueTypes - The Issue Types for context

Returns:

the list of visible Custom Fields applicable to the given context (of project and Issue types).

getHiddenFields

List<Field> getHiddenFields(Project project,
                            List<String> issueTypeIds)

getHiddenFields

List<Field> getHiddenFields(com.atlassian.crowd.embedded.api.User remoteUser,
                            org.ofbiz.core.entity.GenericValue project,
                            List<String> issueTypeIds)

Deprecated. Use getHiddenFields(com.atlassian.jira.project.Project, java.util.List). Since v4.3

getHiddenFields

List<Field> getHiddenFields(com.atlassian.crowd.embedded.api.User remoteUser,
                            Project project,
                            List<String> issueTypeIds)

Deprecated. Use getHiddenFields(com.atlassian.jira.project.Project, java.util.List). Since v4.3

getRequiredFieldLayoutItems

List<FieldLayoutItem> getRequiredFieldLayoutItems(Project project,
                                                  List<String> issueTypes)

getRequiredFieldLayoutItems

List<FieldLayoutItem> getRequiredFieldLayoutItems(com.atlassian.crowd.embedded.api.User remoteUser,
                                                  org.ofbiz.core.entity.GenericValue project,
                                                  List<String> issueTypes)

Deprecated. Use getRequiredFieldLayoutItems(com.atlassian.jira.project.Project, java.util.List). Since v4.3

isFieldHidden

boolean isFieldHidden(String fieldId)

getRendererTypeForField

String getRendererTypeForField(String fieldId)

isDefault

boolean isDefault()

Returns true if this is the default FieldLayout. This means that the "type" field holds "value".

Returns:

true if this is the default FieldLayout.