@PublicApi
public interface FieldLayout
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
The description of the field configuration.
|
FieldLayoutItem |
getFieldLayoutItem(OrderableField orderableField)
Returns the field layout item for a given orderable field, if this orderable field is part of this field configuration.
|
FieldLayoutItem |
getFieldLayoutItem(String fieldId)
Returns the field layout item for a given field if, if this field is part of this field configuration.
|
List<FieldLayoutItem> |
getFieldLayoutItems()
A list of field layout item of this field configuration.
|
org.ofbiz.core.entity.GenericValue |
getGenericValue()
The generic value which represents this field configuration.
|
List<Field> |
getHiddenFields(Project project,
List<String> issueTypeIds)
Returns all hidden fields (system fields and custom fields) for a given project and issue type(s).
|
Long |
getId()
The id of the field configuration.
|
String |
getName()
The name of the field configuration
|
String |
getRendererTypeForField(String fieldId)
Returns the render type for a given field in this field configuration.
|
List<FieldLayoutItem> |
getRequiredFieldLayoutItems(Project project,
List<String> issueTypes)
Returns the list of required fields for an issue type in a project.
|
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> |
getVisibleLayoutItems(ApplicationUser remoteUser,
Project project,
List<String> issueTypes)
Deprecated.
Use
getVisibleLayoutItems(com.atlassian.jira.project.Project, java.util.List) instead. Since v6.2. |
List<FieldLayoutItem> |
getVisibleLayoutItems(Project project,
List<String> issueTypes)
Returns all visible field layout items (system fields and custom fields) for a given project and issue type(s).
|
boolean |
isDefault()
Returns true if this is the default FieldLayout.
|
boolean |
isFieldHidden(String fieldId)
Checks if a field is hidden in this field configuration.
|
Long getId()
String getName()
String getDescription()
List<FieldLayoutItem> getFieldLayoutItems()
org.ofbiz.core.entity.GenericValue getGenericValue()
FieldLayoutItem getFieldLayoutItem(OrderableField orderableField)
orderableField
- the orderable field to find in this field configuration.FieldLayoutItem getFieldLayoutItem(String fieldId)
fieldId
- the id of the field.List<FieldLayoutItem> getVisibleLayoutItems(ApplicationUser remoteUser, Project project, List<String> issueTypes)
getVisibleLayoutItems(com.atlassian.jira.project.Project, java.util.List)
instead. Since v6.2.remoteUser
- the user TODO: User is not used! We should remove it!project
- the projectissueTypes
- a list of issue types to use when checking for VISIBLE CUSTOM FIELDS.List<FieldLayoutItem> getVisibleLayoutItems(Project project, List<String> issueTypes)
project
- the projectissueTypes
- a list of issue types to use when checking for VISIBLE CUSTOM FIELDS.List<FieldLayoutItem> getVisibleCustomFieldLayoutItems(Project project, List<String> issueTypes)
project
- The project contextissueTypes
- The Issue Types for contextList<Field> getHiddenFields(Project project, List<String> issueTypeIds)
project
- the projectissueTypeIds
- issueTypes a list of issue types to use when checking for HIDDEN CUSTOM FIELDS.List<FieldLayoutItem> getRequiredFieldLayoutItems(Project project, List<String> issueTypes)
project
- the projectissueTypes
- the issue type.boolean isFieldHidden(String fieldId)
fieldId
- the field id.String getRendererTypeForField(String fieldId)
fieldId
- the id of the field.boolean isDefault()
Copyright © 2002-2017 Atlassian. All Rights Reserved.