Package com.atlassian.jira.issue.fields.layout.field

Interface FieldLayout

All Known Subinterfaces:
EditableDefaultFieldLayout, EditableFieldLayout
All Known Implementing Classes:
EditableDefaultFieldLayoutImpl, EditableFieldLayoutImpl, FieldLayoutImpl, MockFieldLayout
@PublicApi public interface FieldLayout
NOTE: This is referred to as Field Configuration in the UI.

  • Method Details

    • getId

      Long getId()
      The id of the field configuration.
      Returns:
      the id

    • getName

      String getName()
      The name of the field configuration
      Returns:
      the name

    • getDescription

      String getDescription()
      The description of the field configuration.
      Returns:
      the description

    • getFieldLayoutItems

      List<FieldLayoutItem> getFieldLayoutItems()
      A list of field layout item of this field configuration.
      Returns:
      a list of field layout items of this field configuration.

    • getGenericValue

      org.ofbiz.core.entity.GenericValue getGenericValue()
      The generic value which represents this field configuration.
      Returns:
      the generic value

    • getFieldLayoutItem

      FieldLayoutItem getFieldLayoutItem(OrderableField orderableField)
      Returns the field layout item for a given orderable field, if this orderable field is part of this field configuration.
      Parameters:
      orderableField - the orderable field to find in this field configuration.
      Returns:
      the field layout item if this field is part of this field configuration, otherwise null.

    • getFieldLayoutItem

      FieldLayoutItem getFieldLayoutItem(String fieldId)
      Returns the field layout item for a given field if, if this field is part of this field configuration.
      Parameters:
      fieldId - the id of the field.
      Returns:
      the field layout item if this field is part of this field configuration, otherwise null.

    • getVisibleLayoutItems

      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.
      Returns all visible field layout items (system fields and custom fields) for a given project and issue type(s).
      Parameters:
      remoteUser - the user TODO: User is not used! We should remove it!
      project - the project
      issueTypes - a list of issue types to use when checking for VISIBLE CUSTOM FIELDS.
      Returns:
      all visible field layout items for the given project and it's issue type(s).

    • getVisibleLayoutItems

      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).
      Parameters:
      project - the project
      issueTypes - a list of issue types to use when checking for VISIBLE CUSTOM FIELDS.
      Returns:
      all visible field layout items for the given project and it's issue type(s).

    • 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).

    • getHiddenFields

      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).
      Parameters:
      project - the project
      issueTypeIds - issueTypes a list of issue types to use when checking for HIDDEN CUSTOM FIELDS.
      Returns:
      all hidden fields (system fields and custom fields).

    • getRequiredFieldLayoutItems

      List<FieldLayoutItem> getRequiredFieldLayoutItems(Project project, List<String> issueTypes)
      Returns the list of required fields for an issue type in a project.
      Parameters:
      project - the project
      issueTypes - the issue type.
      Returns:
      the list of required fields. System fields and custom fields.

    • isFieldHidden

      boolean isFieldHidden(String fieldId)
      Checks if a field is hidden in this field configuration.
      Parameters:
      fieldId - the field id.
      Returns:
      true if the field is hidden, otherwise false.

    • getRendererTypeForField

      String getRendererTypeForField(String fieldId)
      Returns the render type for a given field in this field configuration.
      Parameters:
      fieldId - the id of the field.
      Returns:
      the type of the renderer e.g. DefaultTextRenderer.RENDERER_TYPE ("jira-text-renderer")

    • 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.