public class

MockFieldLayout

extends Object
implements FieldLayout
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.layout.field.MockFieldLayout

Class Overview

Simple mock implementation of FieldLayout.

Summary

Public Constructors
MockFieldLayout()
Public Methods
MockFieldLayoutItem addFieldLayoutItem(OrderableField orderableField)
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.
GenericValue getGenericValue()
The generic value which represents this field configuration.
List<Field> getHiddenFields(User remoteUser, GenericValue project, List<String> issueTypeIds)
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).
List<Field> getHiddenFields(User remoteUser, Project project, List<String> issueTypeIds)
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(User remoteUser, Project project, List<String> issueTypes)
Returns all visible field layout items (system fields and custom fields) for a given project and issue type(s).
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.
MockFieldLayout setDefault(boolean defaultLayout)
MockFieldLayout setDescription(String description)
MockFieldLayout setId(Long id)
MockFieldLayout setName(String name)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.layout.field.FieldLayout

Public Constructors

public MockFieldLayout ()

Public Methods

public MockFieldLayoutItem addFieldLayoutItem (OrderableField orderableField)

public String getDescription ()

The description of the field configuration.

Returns
  • the description

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

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

public List<FieldLayoutItem> getFieldLayoutItems ()

A list of field layout item of this field configuration.

Returns
  • a list of field layout items of this field configuration.

public GenericValue getGenericValue ()

The generic value which represents this field configuration.

Returns
  • the generic value

public List<Field> getHiddenFields (User remoteUser, GenericValue project, List<String> issueTypeIds)

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

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

public Long getId ()

The id of the field configuration.

Returns
  • the id

public String getName ()

The name of the field configuration

Returns
  • the name

public 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")

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

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

public List<FieldLayoutItem> getVisibleLayoutItems (User remoteUser, 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
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).

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

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

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

public MockFieldLayout setDefault (boolean defaultLayout)

public MockFieldLayout setDescription (String description)

public MockFieldLayout setId (Long id)

public MockFieldLayout setName (String name)

public String toString ()